Product Documentation

Appearance

config network ​

View or define the system network configuration.

config network bonding [ all | local | remote ] get
config network bonding [ local | remote ] set [ layer2 | layer2+3 | layer3+4 | active-backup ]
config network bmc [ all | local | remote ] get
config network bmc [ local | remote ] set [ dhcp | <ipaddress> <subnet> <gateway> ]
config network database <port>
config network log disable
config network log enable <ipaddress> | <hostname> [ <port> ]
config network log get
config network manager [ all | local | remote ] get
config network manager [ local | remote ] set <ipaddress> <subnet> <gateway> <dns1> [ <dns2> ] <search-domain>
config network mtu get
config network mtu set <mtu>
config network system get
config network system set <ipaddress> <subnet>
config network route create [ all | local | remote ] default [vlanid] <gateway>
config network route create [ all | local | remote ] [vlanid] <ip> <subnet> <gateway>
config network route delete [ all | local | remote ] default [vlanid]
config network route delete [ all | local | remote ] [vlanid] <ip> <subnet> <gateway>
config network route list [ all | local | remote ]
config network trace ph <enable|disable>
config network trace get
config network trace set <bulk|sql|all> <enable|disable>
config network trace set <bulk|sql|all> size <MiBs>
config network trace set <bulk|sql|all> duration <minutes>
config network trace set default
config network vlan create <vlanid>
config network vlan delete <vlanid>
config network vlan list
config network vlan manager [ all | local | remote ] get <vlanid>
config network vlan manager [ local | remote ] set <vlanid> <ipaddress> <subnet> <gateway|none> <dns1|none> [ <dns2|none> ] <search-domain|none>
config network vlan system get <vlanid>
config network vlan system set <vlanid> <ipaddress> <subnet>
bonding

Get or set the network bonding configuration on the manager nodes. For example:

YBCLI (PRIMARY - yb00-mgr0)> config network bonding all get

Network bonding configuration: 
Active    : layer3, layer4
Configured: layer3, layer4

Remote manager node
-------------------

Network bonding configuration: 
Active    : layer3, layer4
Configured: layer3, layer4

The set command specifies the hash algorithm that allocates network traffic to clients (a network client may receive all its traffic on one interface or via both interfaces). Layer 2, Layer 2+3, Layer 3+4, and active-backup hash policies are supported.

  • layer2: the default setting. This option uses the XOR of hardware MAC addresses to generate the hash. All traffic is placed on a particular network peer on the same network client. This algorithm is 802.3ad-compliant.
  • layer2+3: a combination of layer2 and layer3 protocol information is used to generate the hash. All traffic is placed on a particular network peer on the same network client. For non-IP traffic, the formula is the same as for the layer2 transmit hash policy. This policy provides a more balanced distribution of traffic than layer2, especially in environments where a layer3 gateway device is required to reach most destinations. This algorithm is 802.3ad-compliant.
  • layer3+4: this policy uses upper-layer protocol information (when available) to generate the hash. Traffic to a particular network peer may span multiple clients; however, a single connection will not span multiple clients. This algorithm is not 802.3ad-compliant.
  • active-backup: this policy allows redundancy between the ports but not load balancing or increased bandwidth. Only one connection in the bond is active at any time. A different connection becomes active if, and only if, the active connection fails. This mode provides fault tolerance, without needing special support from the connected switch. This algorithm is not 802.3ad-compliant or compatible. 802.3ad mode must be disabled on the corresponding ports of the connected switch.

For example:

YBCLI (PRIMARY - yb00-mgr0)> config network bonding local set layer2
...
bmc

Get or set the BMC configuration on the local or remote manager node. To set the network configuration, enter dhcp or specify the IP address. Here is an example of the get command:

YBCLI (PRIMARY)> config network bmc all get

BMC network configuration
-------------------------
IP address  : 10.20.100.13
Subnet mask : 255.255.0.0
Gateway     : 10.20.0.1

Remote manager node
-------------------

BMC network configuration
-------------------------
IP address  : 10.20.100.13
Subnet mask : 255.255.0.0
Gateway     : 10.20.0.1
database <port>

Set the port number that is used for external client access to the database (the default is 5432).

log disable

Disable sending logs to a remote syslog server. For example:

YBCLI(26355) (PRIMARY - yb99-mgr1)> config network log disable

Successfully disabled remote logging on this manager node
Restarting logging... Done
log enable <ipaddress> | <hostname> [ <port> ]

Enable sending the following logs to the specified remote syslog server:

  • System log
  • Executed ybcli commands
  • Executed encryption and keystore commands
  • All log data from blades and query execution
  • User log in/out of system

The port must be 514 or a number greater than 1024 but less than or equal to 65535. Port udp/514 is the default if a port number is not provided. For example:

YBCLI(6350) (PRIMARY - yb99-mgr1)> config network log enable 10.20.100.10 514

Successfully enabled remote logging to 10.20.100.10:514 on this manager node
Restarting logging... Done
YBCLI(50902) (PRIMARY - y2b23-mgr0)> config network log enable yellowbrick.io

Successfully enabled remote logging to yellowbrick.io:514 on this manager node
Restarting logging... Done
log get

Get the IP address and the port used for sending logs to a remote server. For example:

YBCLI(6350) (PRIMARY - yb99-mgr1)> config network log get

Remote network logging configured to use:
IP address: 10.20.100.10
Port      : 514
manager get | set

Get or set the network configuration for the local or remote manager node. For example:

YBCLI(9460) (PRIMARY - yb100-mgr0)> config network manager local get

Manager IP     : 10.20.100.12/255.255.0.0 - Link UP
Manager gateway: 10.20.0.1
Manager DNS    : DNS1: 10.20.12.12 - DNS2: NOT SET
mtu get | set

Get or set the network MTU of the customer-facing network adapters. The MTU setting must be between 1500 and 9000, and the specified size that you set must be supported on the network. For example:

YBCLI (PRIMARY)> config network mtu get

Customer network MTU: 1500 bytes

Remote manager node
-------------------

Customer network MTU: 1500 bytes
YBCLI (PRIMARY)> config network mtu set 9000

Changing the network MTU can be a disruptive process and possibly disconnect both manager nodes from the network if not supported
Before changing the MTU, please verify the size chosen is supported on this network

Type yes to continue: 
...
system get | set

Get or set the floating IP address for the system. For example:

YBCLI (PRIMARY)> config network system get

System floating IP: 10.30.111.10/24 - Link UP
route create [ all | local | remote ] default [vlanid] <gateway>

Set the default gateway for the network interface. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network route create local default 4000 172.16.155.1

Successfully set default gateway
route create [ all | local | remote ] [vlanid] <ip> <subnet> <gateway>

Create a static route for the network. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network route create local 4000 172.16.104.1 255.255.255.0 172.16.40.10

Successfully added new static route
route delete [ all | local | remote ] default [vlanid]

Delete the default gateway for the network interface.

route delete [ all | local | remote ] [vlanid] <ip> <subnet> <gateway>

Delete a static route for the network. For example:

YBCLI(1484) (PRIMARY - yb99-mgr1)> config network route delete local 4000 172.16.104.1 255.255.255.0 172.16.40.10

Successfully deleted static route
route list [ all | local | remote ]

List all default gateways and static routes for each interface. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network route list local

	Main:
		Gateway: 10.20.0.1
		Static Routes: None
	VLAN ID:36:
		Gateway: 172.16.36.221
		Static Routes: 192.168.227.0/255.255.255.0 : 172.16.36.227
		               192.168.217.0/255.255.255.0 : 172.16.36.217
	VLAN ID:4000:
		Gateway: 172.16.155.1
		Static Routes: 172.16.104.1/255.255.255.0 : 172.16.40.10
trace ph <enable|disable>

Enable or disable sending network traces to Phonehome. By default, config network trace ph is disabled. For example:

YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace ph disable
 
Network tracing successfully disabled for phonehome (ph)
trace get

Get the current configuration for network trace. For example:

YBCLI(36333) (PRIMARY - yb98-mgr0)> config network trace get
 
Network Trace configuration:
       Bulk Ports: TCP[31000-41000] disabled, max 10240 MiB, duration 1440 minutes
       SQL Ports: TCP[5432] disabled, max 10240 MiB, duration 1440 minutes
       Upload to phonehome: disabled
trace set <bulk|sql|all> <enable|disable>

Enable or disable network trace for a specified trace type. By default, config network trace set is disabled. For example:

YBCLI(36333) (PRIMARY - yb98-mgr0)> config network trace set all disable
 
Network tracing successfully disabled for bulk port
 
Files are stored in /tmp/network_trace/*network_trace_bulk*.pcap*
 
Network tracing successfully disabled for SQL port
 
Files are stored in /tmp/network_trace/*network_trace_sql*.pcap*
trace set <bulk|sql|all> size <MiBs>

Set overall trace size for a specified trace type. By default, trace size is 10240 MiB. For example:

YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace set sql size 5120
 
Network tracing size set successfully for SQL port
YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace set all size 5120
 
Network tracing size set successfully for bulk port
 
Network tracing size set successfully for SQL port
trace set <bulk|sql|all> duration <minutes>

Set the duration for a specified network trace run. By default, traces run for 1440 minutes (24 hours). For example:

YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace set bulk duration 5
 
Network tracing duration set successfully for bulk port
YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace set sql duration 5
 
Network tracing duration set successfully for SQL port
YBCLI(26269) (PRIMARY - yb00-mgr0)> config network trace set all duration 5
 
Network tracing duration set successfully for bulk port
 
Network tracing duration set successfully for SQL port
trace set default

Reset all network trace settings to the default values. For example:

YBCLI(36333) (PRIMARY - yb98-mgr0)> config network trace set default
 
Network tracing successfully set defaults
vlan create

Create a VLAN. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network vlan create 1000

Are you sure you want to create a VLAN with ID:1000?
Response (yes/no): yes

Successfully created vlan with ID 1000

Remote manager node
-------------------

Creating VLAN. Standby...

Successfully created vlan with ID 1000
vlan delete

Delete a VLAN. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network vlan delete 1000

Successfully deleted vlan with ID 1000

Remote manager node
-------------------

Successfully deleted vlan with ID 1000
vlan list

Return a list of current VLANs. For example:

YBCLI(26899) (PRIMARY - yb100-mgr1)> config network vlan list

VLAN IDs configured: 	1000, 4000, 36

Remote manager node
-------------------

VLAN IDs configured: 	1000, 4000, 36
vlan manager [ all | local | remote ] get

Get the manager node network configuration for the VLAN. For example, get the network configuration on both manager nodes for the VLAN with ID 36:

YBCLI(8206) (SECONDARY - yb100-mgr0)> config network vlan manager all get 36

Manager IP     : 172.16.36.12/255.255.255.0 - Link UP
Manager gateway: NOT SET
Manager DNS    : DNS1: 1.1.1.1 - DNS2: NOT SET
Manager Domain : blah.com

Remote manager node
-------------------

Manager IP     : UNKNOWN/UNKNOWN - Link UP
Manager gateway: NOT SET
Manager DNS    : DNS1: NOT SET - DNS2: NOT SET
Manager Domain : NOT SET
vlan manager [ local | remote ] set

Set the manager node network configuration for the VLAN. For example, set the network configuration for a VLAN with ID 1000 on the local manager node:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network vlan manager local set 1000 172.16.200.12 255.255.255.0 172.16.200.1 8.8.8.8 none example.com

The local manager node VLAN ID:1000 network will be set to:
IP     : 172.16.200.12
Subnet : 255.255.255.0
Gateway: 172.16.200.1
DNS1   : 8.8.8.8
DNS2   : none
Domain : example.com
Continue (yes/no)? yes

Successfully set new VLAN ID:1000 network configuration

Should the new settings be applied immediately?
Warning: This may cause loss of connectivity if settings of the local system are changed and YBCLI is run remotely.
Typing 'no' will cause settings to take effect on next reboot.
Response (yes/no): yes
Restarting network interface. This can take 20s. Standby...
Network has been restarted with the new configuration
vlan system get | set

Get or set the system IP configuration (cluster floating IP) for the VLAN. For example:

YBCLI(1484) (PRIMARY - yb100-mgr1)> config network vlan system set 1000 172.16.200.10 255.255.255.0

Are you sure you want to set the VLAN ID:1000 floating system IP to: 172.16.200.10/255.255.255.0
Response (yes/no): yes
Verifying IP is not in use on network. Standby...
IP address is available

Creating cluster IP configuration for VLAN ID:1000. Standby...
Successfully created cluster IP configuration for VLAN ID:1000 with address: 172.16.200.10/255.255.255.0

Waiting for IP address to become active. This can take 90s. Standby... Done
YBCLI(8206) (SECONDARY - yb100-mgr0)> config network vlan system get 4000

VLAN ID: 4000 System floating IP: UNKNOWN/UNKNOWN - Link UP
YBCLI(8206) (SECONDARY - yb100-mgr0)> config network vlan system get 36

VLAN ID: 36 System floating IP: UNKNOWN/UNKNOWN - Link UP

Parent topic:config