Network functions

---

networkIPValid

Is a network IP valid?

Usage

networkIPValid [ --help ] [ ip ]

Must be valid IPv4 or IPv6 address.

Location: bin/build/tools/network.sh

Arguments

• --help - Flag. Optional. Display this help.
• ip - String. IP to test for validity.

Reads standard input

line:String - Network IPs to test for validity.

Return codes

• 0 - All network IPs passed in are valid.
• 1 - One or more network IPs passed in are not valid

networkNameValid

Is a network host name valid?

Usage

networkNameValid [ --help ] [ name ]

Must be valid name containing alphabetic characters, dashes, or dots. Dotted sections must be no longer than 63 characters; total name must be no longer than 253 characters.

Location: bin/build/tools/network.sh

Arguments

• --help - Flag. Optional. Display this help.
• name - String. Network name to test for validity.

Reads standard input

line:String - Network names to test for validity.

Return codes

• 0 - All network names passed in are valid.
• 1 - One or more network names passed in are not valid

networkMACAddressList

List MAC addresses associated with this system using ifconfig

Usage

networkMACAddressList [ --install ] [ --help ]

List MAC addresses associated with this system using ifconfig

Location: bin/build/tools/network.sh

Arguments

• --install - Flag. Optional. Install any packages required to get ifconfig installed first.
• --help - Flag. Optional. This help.

Sample Output

lines:IPv4

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

networkNameFull

Platform-agnostic host name

Usage

networkNameFull

Get the full hostname on the current platform. Formerly hostname``Full.

Location: bin/build/tools/host.sh

Arguments

• none

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Requires

• helpArgument - Simple help argument handler. (source)
• executableRequire - Check that one or more binaries are installed (source)
• catchEnvironment - Run `command`, upon failure run `handler` with an environment error (source)

networkIPLookup

Get the current IP address of a host

Usage

networkIPLookup [ --help ]

Get the current IP address of a host

Location: bin/build/tools/network.sh

Arguments

• --help - Flag. Optional. Display this help.

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

Environment

• IP_URL IP Lookup URL – URL. URL to look up IP my address remotely
• IP_URL_FILTER Filter for IP Lookup – String. jq filter to parse IP_URL result (assuming JSON)

networkIPList

List IPv4 Addresses associated with this system using ifconfig

Usage

networkIPList [ --install ] [ --help ]

List IPv4 Addresses associated with this system using ifconfig

Location: bin/build/tools/network.sh

Arguments

• --install - Flag. Optional. Install any packages required to get ifconfig installed first.
• --help - Flag. Optional. This help.

Sample Output

lines:IPv4

Return codes

• 0 - Success
• 1 - Environment error
• 2 - Argument error

---

🛠️ Tools · ⬅ Top