Get

/vms/{id}/network_settings/

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Responses

200

Expand All

object

management_vips

Array of string

string

Virtual IP address configured on the management interfaces on all CNodes. VMS listens on this IP.

external_gateways

Array of string

string

Default gateway for VMS network

dns

Array of string

string

The IP address(es) of any DNS servers that will forward DNS queries to the cluster

ntp

Array of string

string

The IP(s) of any NTP server(s) that you want to use for time keeping

ext_netmask

string

The subnet mask of the management subnet

auto_ports_ext_iface

string

Allocates the external management IP to one of the following: - Outband. Allocates the external management IP to the onboard left or right port, depending whether B2B is enabled or not. - Inband. Allocates the external management IP to the bond0 interface. - Bond. Creates a bond interface (bond1) on the two RJ45 ports, allowing for redundancy. Negates the ability to have a technician interface. - Northband. For clusters with dual NIC CNodes where one NIC on each CNode is directly connected to the an external client network, this option allocates the external management IP to the externally connected NIC.

Valid values[ "inband", "outband", "bond", "northband" ]

b2b_ipmi

boolean

Enables auto configuring the IPMI ports on the nodes with IP addresses according to the B2B template.

eth_mtu

integer

The MTU size for the CNode and DNode internal network interfaces, for clusters with Ethernet internal network infrastructure. The MTU should be aligned with the switches. Default=9216.

ib_mtu

integer

The MTU size for the CNode and DNode internal network interfaces, for clusters with IB internal network infrastructure. Default=2044. Set a supported MTU for the NIC mode: If IB type is Connected, the maximum IB NB MTU is 65520. If IB type is Datagram, the maximum IB NB MTU is 4092

ipmi_gateway

string

The IP of a default gateway for the IPMI interfaces on the CNodes and DNodes, if different from the management network default gateway.

ipmi_netmask

string

The subnet mask for the IPMI gateway.

boxes

Array of object

object

box_name

string

Name of CBox or DBox

hosts

Array of object (HostNetworkSettings)

Configuration of each CNode or DNode in the CBox or DBox

object

id

integer

The ID of the CNode or DNode

hostname

string

The hostname of the CNode or DNode

nb_eth_mtu

integer

For dual-NIC CNodes where a NIC is directly connected to an external Ethernet network, use this field to set the MTU for that Ethernet network.

nb_ib_mtu

integer

For dual-NIC CNodes where a NIC is directly connected to an external InfiniBand data network, use this field to set the MTU for that InfiniBand network. Default is 2044. If NB IB type is Connected, the maximum IB NB MTU is 65520. If NB IB type is Datagram, the maximum IB NB MTU is 4092.

mgmt_ip

string

The management IP of the CNode or DNode

ipmi_ip

string

The IPMI IP of the CNode or DNode

Return the network settings of VMS