The following section describes Network records.
A network record contains information about a particular network that is configured for use by the BFC. You can use this information for the following purposes:
For example, server discovery, IPMI power configuration, or application IPs that you designated for grid use.
A network record contains the following fields:
|
Field |
Type |
Description |
|
comp_id |
integer |
Read-only field that contains the resource component ID for the network resource. |
|
base_address |
string |
Subnet address that defines the network. This field becomes read-only after you set it initially. |
|
cidr |
integer |
CIDR for the network record. This field becomes read-only after you set it initially. |
|
ip_version |
string |
Read-only protocol version of IPV4 or IPV6. Note: This version of the BFC API does not support IPV6. |
|
usages |
[string] |
Lists of one or more use name descriptors that indicate how to provision the network address space for BFC use. For example, backbone, external, power, or external and power. |
|
gateway_addresses |
[string] |
List of IP addresses that define the gateways that are used for the network. |
|
address_space |
ip_space |
IP Space that describes how the network addresses are allocated to ranges amongst each IP type for the network. This field is constrained by the usage combination defined for the network. This field becomes read-only after you set it initially. |
|
vlan_address_spaces |
[vlan_ip_space] |
Lists of VLAN IP Space records that describe how the network addresses are allocated to ranges amongst each VLAN. This field becomes read-only after you set it initially. You can add or delete VLAN IP Spaces post network creation. |
The IP pool record lists ranges of IP addresses within a network for a specific use type. An IP address can only belong to one IP pool.
An ip_pool record contains the following fields:
|
Field |
Type |
Description |
|
type |
string |
Contains the type of IP pools that you want to assign for the network. Valid values include application, hardware, power, and user. This field becomes read-only after you set it initially. |
|
ranges |
[ip_range] |
Contains the ranges of the IP pools. |
|
available_ranges |
[ip_range] |
Read-only list that contains the available IP pool ranges. |
|
used_ranges |
[ip_range] |
Read-only list that contains the used IP pool ranges. |
|
num_available |
integer |
Read-only list that contains the number of available IP pools. |
|
num_used |
integer |
Read-only list that contains the number of used IP pools. |
The IP Range record lists a sequential range of IP addresses. The IP Range defines the address that starts the range, the last address in the range, and the number of included addresses in the range.
An ip_range record contains the following fields:
|
Field |
Type |
Description |
|
start_address |
string |
Address for the range in IP string format. |
|
end_address |
string |
End-address (inclusive) for the range in IP string format. |
|
size |
integer |
Read-only size of the range by the total number of included addresses by the range. |
The IP space record lists information about the allocated network address ranges amongst each network.
An ip_space record contains the following fields:
|
Field |
Type |
Description |
|
available_ranges |
[ip_range] |
Read-only list of the available ranges for the network. |
|
address_pools |
[ip_pool] |
Lists the address pools used for the network. |
The VLAN IP space record lists information about the allocated network address ranges amongst each VLAN.
A vlan_ip space record contains the following fields:
|
Field |
Type |
Description |
|
vlan |
integer |
The VLAN that you associate with this IP spaces record. This field becomes read-only after you set it initially. |
|
available_ranges |
[ip_range] |
Read-only available ranges for the VLAN IP spaces. |
|
address_pools |
[ip_pool] |
Lists the address pools used for the VLAN IP spaces. |
|
Copyright © 2013 CA Technologies.
All rights reserved.
|
|