Description
- It assigns the next available, or manually defined, IP address.
- It optionally adds a DNS host record and MAC address that are linked to the IP address.
- It returns the property string containing the IP address, netmask, and gateway.
- If the addDeviceInstance API is used to add a static host record and
this record is either updated or deleted followed by a full
deployment, the changes will not be sent to BDDS resulting in
duplicate host records.
After either updating or deleting a static host record that was added using the addDeviceInstance API, a quick, differential, or selective deployment must be performed prior to performing a full deployment. Failing to do so will result in duplicated records on BDDS.
A quick deployment is only effective if initiated by the same user that performed the initial change.
- Static host records are not visible on BDDS, but are visible in BAM
in the following scenario:
- When a static host record is added using the
addDeviceInstance API and the same host record is deleted
then deployed through the Address Manager user interface
proceeded by the recreation of the original static host
record on the same IP address using the addDeviceInstance
API during the deployment.
The static host record that is visible in BAM will become visible on BDDS once another deployment is performed.
- When a static host record is added using the
addDeviceInstance API and the same host record is deleted
then deployed through the Address Manager user interface
proceeded by the recreation of the original static host
record on the same IP address using the addDeviceInstance
API during the deployment.
- If the addDeviceInstance API is used more than once to add the same
static host record with the allowDuplicateHosts DNS deployment
option set to true, the host record will be linked to two
different IP addresses in BAM. However, on BDDS, only one IP address
is linked to the host record.
The static host record that is visible in BAM will become visible on BDDS once another deployment is performed.
Parameters
Name | Description |
---|---|
configName |
Location: query Type: string Name of parent configuration. If the value is empty or
cannot be found, an exception will be thrown.
|
deviceName |
Location: query Type: string IP address or device name of the new instance. This is
reserved for future use.
|
ipAddressMode |
Location: query Type: string Accepted values are:
|
ipEntity |
Location: query Type: string If ipAddressMode is REQUEST_STATIC or
REQUEST_DHCP_RESERVED, this must be the
network where the IP address will be provisioned from in
the format of an IP address range in CIDR format or
range.
If ipAddressMode is PASS_VALUE, this must be an IP address. |
macAddressMode |
Location: query Type: string Accepted values are:
If you specify an empty string, the MACEntity parameter will be ignored. |
macEntity |
Location: query Type: string If macAddressMode is PASS_VALUE, this
must be a MAC address. If macAddressMode is
REQUEST_VALUE, this is a MAC mask.
|
options |
Location: query Type: string The options string contains four properties:
skip, offset, excludeDHCPRange,
and allowDuplicateHosts.
Note: The values for skip and offset must
be IPv4 addresses and must appear in dotted octet
notation.
|
recordName |
Location: query Type: string Name of the host record to add. This cannot be empty if
both viewName and zoneName are specified
and in use. The viewName, zoneName, and
recordName parameters must be used together:
the values must all be an empty string, or they
must all be populated with specific values.
Note: If all
three parameter values are an empty string, DNS
objects will not be created but an IP address will
be assigned from a network and linked to a MAC
address.
|
viewName |
Location: query Type: string Name of parent view.
Note: Specify an empty string ("")
for all viewName, zoneName, and
recordName parameters to ignore DNS object
creation.
|
zoneName |
Location: query Type: string Parent zone of the record. This must be specified and
existing if the viewName parameter is an empty
string and existing.
Note: Specify an empty string for
all viewName, zoneName and
recordName parameters to ignore DNS object
creation.
|
Responses
Code | Description |
---|---|
201 |
Type: string Returns the property string containing IP address,
netmask, and gateway.
|