Additional IP addresses - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0
You use the interfaces configuration to configure additional IP addresses for interfaces, including bonding interfaces, and static routes.
Attention: This service cannot be configured on DNS/DHCP Servers operating in an xHA pair.
Attention: When configuring additional IP addresses, you must include all physical interfaces in the body of the JSON configuration, regardless of whether you are updating configurations for that interface. For example, if your DNS/DHCP Server includes eth0, eth1, and eth2 interfaces, you must include the configurations of all configuration information of each interface in the body of the JSON configuration even if you are only updating the configuration of eth1.

You can also configure individual interfaces when provisioning a DNS/DHCP Server using cloud-init. For more information, refer to Configuring DNS/DHCP Server services using cloud-init.

Configuring additional IP addresses

Additional DNS service addresses provide flexibility and centralized control when consolidating old DNS servers into one single server without disrupting any configurations that might be using the old IP addresses.

Example
{
    "version": "1.0.0",
    "services": {
        "interfaces": {
            "configurations": [
                {
                    "interfacesConfiguration": {
                        "dedicatedManagement": true,
                        "networkInterfaces": [
                            {
                                "eth0": {
                                    "physical": {
                                        "active": true,
                                        "description": "eth0",
                                        "v4addresses": [
                                            {
                                                "ip4": "192.168.47.11",
                                                "cidr": 24
                                            }
                                        ],
                                        "v6addresses": [
                                            {
                                                "ip6": "fda5:1111:47::11",
                                                "cidr": 64
                                            }
                                        ]
                                    },
                                    "vlan": [
                                        {
                                            "vlanid": 1,
                                            "description": "eth0.1",
                                            "active": true,
                                            "v4addresses": [
                                                {
                                                    "ip4": "1.1.1.1",
                                                    "cidr": 24
                                                },
                                                {
                                                    "ip4": "1.1.1.2",
                                                    "cidr": 24
                                                }
                                            ],
                                            "v6addresses": []
                                        }
                                    ]
                                }
                            },
                            {
                                "eth1": {
                                    "physical": {
                                        "v4addresses": [],
                                        "description": "eth1"
                                        "active": false,
                                        "v6addresses": []
                                    }
                                }
                            },
                            {
                                "eth2": {
                                    "physical": {
                                        "active": true,
                                        "description": "eth2",
                                        "v4addresses": [
                                            {
                                                "ip4": "192.168.47.12",
                                                "cidr": 24
                                            }
                                        ],
                                        "v6addresses": []
                                    },
                                    "vlan": [
                                        {
                                            "vlanid": 2,
                                            "description": "eth2.2",
                                            "active": true,
                                            "v4addresses": [
                                                {
                                                    "ip4": "2.1.1.1",
                                                    "cidr": 24
                                                },
                                                {
                                                    "ip4": "2.1.1.2",
                                                    "cidr": 24
                                                }
                                            ],
                                            "v6addresses": []
                                        }
                                    ]
                                }
                            }
                            {
                                "lo": {
                                    "active": true,
                                    "description": "Loopback interface description",
                                    "v4addresses": [
                                        {
                                            "ip4": "127.0.0.2",
                                            "cidr": 32
                                        },
                                        {
                                            "ip4": "1.1.1.2",
                                            "cidr": 32
                                        }
                                    ],
                                    "v6addresses": [
                                        {
                                            "ip6": "fc00:729::101",
                                            "cidr": 128
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}
Parameters
  • dedicatedManagement—set to true to enable dedicated management; set to false to disable dedicated management.
    Attention: You cannot update the dedicatedManagement setting.
  • networkInterfaces—enter the network interfaces that you would like to configure. You can configure ethernet interfaces (eth), loopback interface (lo), or bonding interfaces (bond).

    For more information on configuring bonding interfaces, refer to Configuring bonding interfaces.

    Attention:
    • You can configure multiple eth<number> interfaces. However, the number of eth interfaces configured on the DNS/DHCP Server is dependent on how many interfaces are available on the virtual machine or appliance.
    • You cannot update the ip4 and ip6 addresses of the eth0, eth2, and bond0 interfaces.
    • active—set to true to activate the specified interface; set to false to deactivate the specified interface.
    • description—enter a description for the specified interface. You can enter up to 80 alphanumeric characters including spaces, but excluding special characters.
    • v4addresses—enter the IPv4 addresses that you would like to configure for the interface.
      • ip4—enter the IPv4 address of the specified interface.
      • cidr—enter the CIDR of the IP space for the specified interface.
    • v6addresses—enter the IPv6 addresses that you would like to configure for the interface.
      • ip6—enter the IPv6 address of the specified interface.
      • cidr—enter the CIDR of the IP space for the specified interface.
    • vlan—enter the VLAN information for the specified interface.
      Attention: You cannot configure the primary IP address of a VLAN interface.
      • vlanid—enter the VLAN ID of the specified interface. The VLAN ID can be a number from 1 to 4094.
      • description—enter a description for the VLAN interface. You can enter up to 80 alphanumeric characters including spaces, but excluding special characters.
      • active—set to true to activate the VLAN interface; set to false to deactivate the VLAN interface.
      • v4addresses—enter the IPv4 addresses that you would like to configure for the interface.
        • ip4—enter the IPv4 address of the specified interface.
        • cidr—enter the CIDR of the IP space for the specified interface.
      • v6addresses—enter the IPv6 addresses that you would like to configure for the interface.
        • ip6—enter the IPv6 address of the specified interface.
        • cidr—enter the CIDR of the IP space for the specified interface.

Configuring bonding interfaces

You can configure network redundancy through port bonding.

Supported bonding modes

DNS/DHCP Server appliances support:
  • FailoverActive/Backup bonding where only one interface in the bond is active (Primary). This allows the secondary interface (eth3) to take over transparently if the Primary interface (eth0) fails.
  • Load BalancingActive/Active bonding using industry standard 802.3ad aggregation protocol, where aggregation groups share the same speed and duplex settings. Each interface shares the throughput and each interface is active; neither interface is a primary nor a secondary.
Example
{
    "version": "1.0.0",
    "services": {
        "interfaces": {
            "configurations": [
                {
                    "interfacesConfiguration": {
                        "dedicatedManagement": false,
                        "networkInterfaces": [
                            {
                                "bond0": {
                                    "mode": "activeBackup",
                                    "physical": {
                                        "active": true,
                                        "description": "bond interface description",
                                        "v4addresses": [
                                            {
                                                "ip4": "10.0.0.1",
                                                "cidr": 24
                                            }
                                        ],
                                        "v6addresses" :[]
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        }
    }
}
Parameters
  • bond—enter the network interfaces that you would like to configure.
    • mode—enter the type of bond mode that you would like to configure. The value can be activeActive or activeBackup
  • active—set to true to activate the specified interface; set to false to deactivate the specified interface.
  • description—enter a description for the specified interface. You can enter up to 80 alphanumeric characters including spaces, but excluding special characters.
  • v4addresses—enter the IPv4 addresses that you would like to configure for the interface.
    Attention: You cannot update the ip4 addresses of an existing bond0 interface.
    • ip4—enter the IPv4 address of the specified interface.
    • cidr—enter the CIDR of the IP space for the specified interface.
  • v6addresses—enter the IPv6 addresses that you would like to configure for the interface.
    • ip6—enter the IPv6 address of the specified interface.
    • cidr—enter the CIDR of the IP space for the specified interface.

Configuring static routes

You can also add static routes to indicate where the system should send packets intended for certain IP addresses. Packets to be sent to hosts on the same subnet as the DNS/DHCP Server or can be routed directly to that subnet. The same procedures can be used to manage either IPv4 or IPv6 routes.

Warning: Ensure that the network route information that you are configuring is correct, as providing invalid route information might make the server inaccessible.
Note: IPv4 and IPv6 static routes are persisted by DNS/DHCP Server after a reboot or after performing a software upgrade.
Note: DNS/DHCP Server no longer permits configuration of duplicate static routes

DNS/DHCP Server v8.1.0 or greater doesn't permit static routes that duplicate the network address and netmask of IP addresses configured on physical interfaces. However, you can configure static routes that overlap existing IP addresses on physical interfaces. That is, network addresses that are larger or smaller than the IP addresses on eth0, or eth2.

Example
{
    "version": "1.0.0",
    "services": {
        "interfaces": {
            "configurations": [
                {
                    "interfacesConfiguration": {
                        "dedicatedManagement": false,
                        "routes": [
                            {
                                "network": "default",
                                "gateway": "192.168.47.1",
                                "cidr": 0
                            }
                        ]
                    }
                }
            ]
        }
    }
}
Parameters
  • routes—enter the static route information that you would like to configure.
    • network—enter the IP address of the network. If you are configuring a default route, set the value to default
    • gateway—enter the IP address of the default gateway.
    • cidr—enter the CIDR of the IP space for the specified network. If you are configuring a default route, set the value to 0.