This method retrieves appliance network information. It returns a NetworkInfo object which contains network information about the appliance.
Synopsis
NetworkInfo getNetworkInfo();
NetworkInfo contains network information of the appliance. It has the following fields:
Field | Description |
---|---|
DnsInfo dns | DNS information about the appliance.protectedNetwork |
InterfaceInfo[] interfaces | Class that contains network interface information about the appliance. |
Field | Description |
---|---|
DnsMode | Enum that describes the source of DNS servers. It enumerates the following values:
|
dnsMode | DNS mode. The value should be one of DnsMode enum. |
hostname | Hostname |
servers | Servers. This value is ignored while in DHCP mode. |
InterfaceInfo contains network interface information about the appliance. It has the following fields:
Field | Description |
---|---|
name | Interface name. For example, "nic0", "nic1". |
interfaceStatus | Interface status. The value should be one of the InterfaceStatus Enums. |
mac | MAC address. For example, 00:0C:29:94:BB:5A. |
IPv4Info ipv4 | IPv4 Address information. |
IPv6Info ipv6 | IPv6 Address information. |
IPv4Info defines the IPv4 configuration state of a network interface. It has the following fields:
Field | Description |
---|---|
interfaceName | Interface name. For example, "nic0", "nic1". |
mode | Address assignment mode. Value should be one of the IPv4Mode enums. |
address | IPv4 address, for example, "10.20.80.191". Value not needed when DHCP mode. |
prefix | IPv4 CIDR prefix, for example , 24. This value is not required while in DHCP mode. For more information, see http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. |
defaultGateway | IPv4 address of the default gateway. This Value is not required while in DHCP mode. |
IPv4Mode defines different IPv4 modes. It has the following fields:
Field | Description |
---|---|
DHCP | IPv4 address is automatically assigned by a DHCP server. |
STATICMODE | IPv4 address is static. |
UNCONFIGURED | The IPv4 protocol is not configured. |
IPv6Info contains IPv6 info on a particular interface. It has the following fields:
Field | Description |
---|---|
interfaceName | Network interface. For example, "nic0" to configure. |
dhcp | Address assigned by a DHCP server. This option can be set to true in parallel with autoconf and static IPv6 addresses. |
autoconf | Address is assigned by Stateless Address Autoconfiguration (SLAAC). This option can be set to true in parallel with dhcp and static IPv6 addresses. |
IPv6Address[] addresses | A list of addresses to be statically assigned. Values can be available in parallel with set dhcp and autoconf. |
defaultGateway | Default gateway for static IP address assignment. This configures the global IPv6 default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. |
IPv6Address is used for naming an IPv6 address. It has the following fields:
Field | Description |
---|---|
address | IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. |
prefix | IPv6 CIDR prefix, for example, 64. |
Faults
- RuntimeFault
For more information about the faults, see Faults in Site Recovery Manager Appliance Management API.