IPv4Objects - BlueCat Address Manager - 9.0.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.0.0

Object Type Properties Read-only/Updatable
IP4Block CIDR = CIDR value of the block. (if it forms a valid CIDR.) Read-only
name = name of the block Both
defaultDomains = Comma separated IDs of the default domains. Both
start = Start of the block. (if it does not form a valid CIDR) Read-only
end = End of the block. (if it does not form a valid CIDR) Read-only
defaultView = ID of the default View for the block. Both
dnsRestrictions = Comma separated IDs of the DNS zones or Views to restrict the IPv4 blocks to be used in. Both
allowDuplicateHost = Duplicate host names check option property. The possible values are Enable or Disable. Both
pingBeforeAssign = Ping check option property. The possible values are Enable or Disable. Both
inheritAllowDuplicateHost = Duplicate host names inheritance check option property. The possible values are True or False. If True, the AllowDuplicateHost option set at the parent object level will be used. If False, the allowDuplicateHost option must be specified and the value specified will be used. Both
inheritPingBeforeAssign = PingBeforeAssign option inheritance check option property. The possible values are True or False. If True, the PingBeforeAssign option set at the parent object level will be used. If False, the PingBeforeAssign option must be specified and the value specified will be used. Both
inheritDNSRestrictions = The possible values are True or False. If True, the IDs of the DNS zone or View to restrict the IPv4 blocks to be used in will be inherited from the parent object. If False, the DNSRestrictions option must be specified and the value specified will be used. Both
inheritDefaultDomains = The possible values are True or False. If True, the IDs of the default domain will be inherited from the parent object. If False, the DefaultDomains option must be specified and the value specified will be used. Both
inheritDefaultView = The possible values are True or False. If True, the ID of the default View for the block will be inherited from the parent object. If False, the DefaultView option must be specified and the value specified will be used. Both
locationCode = The hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1.
Note: The code is case-sensitive. It must be all UPPER CASE letters. The country code and child location code should be alphanumeric strings.
Both
locationInherited = This defines if the location property was defined directly on the object level or was inherited from the parent object. Read-only
IP4Network name = Name of the network. Both
CIDR = CIDR value of the block. (if it forms a valid CIDR.) Read-only
template = ID of the linked template. Read-only
gateway = Gateway of the network. Both
defaultDomains = Comma separated IDs of the default domains. Both
defaultView = ID of the default view for the block. Both
dnsRestrictions = Comma separated IDs of the DNS zones or views to restrict the IPv4 networks to be used in. Both
allowDuplicateHost = Duplicate host names check option property. The possible values are Enable or Disable. Both
pingBeforeAssign = Ping check option property. The possible values are Enable or Disable. Both
inheritAllowDuplicateHost = Duplicate host names inheritance check option property. The possible values are True or False. If True, the AllowDuplicateHost option set at the parent object level will be used. If False, the allowDuplicateHost option must be specified and the value specified will be used. Both
inheritPingBeforeAssign = PingBeforeAssign option inheritance check option property. The possible values are True or False. If True, the PingBeforeAssign option set at the parent object level will be used. If False, the PingBeforeAssign option must be specified and the value specified will be used. Both
inheritDNSRestrictions = The possible values are True or False. If True, the IDs of the DNS zone or View to restrict the IPv4 blocks to be used in will be inherited from the parent object. If False, the DNSRestrictions option must be specified and the value specified will be used. Both
inheritDefaultDomains = The possible values are True or False. If True, the IDs of the default domain will be inherited from the parent object. If False, the DefaultDomains option must be specified and the value specified will be used. Both
inheritDefaultView = The possible values are True or False. If True, the ID of the default View for the block will be inherited from the parent object. If False, the DefaultView option must be specified and the value specified will be used. Both
locationCode = The hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1.
Note: The code is case-sensitive. It must be all UPPER CASE letters. The country code and child location code should be alphanumeric strings.
Both
locationInherited = This defines if the location property was defined directly on the object level or was inherited from the parent object. Read-only
IP4Address address = Address string. Read-only
state = state of the address. For possible values, refer to IP Address States. Read-only
macAddress = MAC address of the IP4Address. Both
routerPortInfo = Connected router port information of the IPv4Address. Read-only
switchPortInfo = Connected switch port information of the IPvAddress. Read-only
vlanInfo = VLAN information of the IPv4Address. Read-only
ptrs = a string providing unmanaged external host records with which the IPv4 address will be associated in the format:
viewId,exHostFQDN[, viewId,exHostFQDN,...]
Write-only
leaseTime = the time when the IP address was leased. Read-only
expiryTime = the date and time that the DHCP lease expires. This is only for the DHCP Allocated IP address type. Read-only
parameterRequestList = the list of parameters the device requested from the DHCP server. Read-only
vendorClassIdentifier = an identifier sent by the DHCP client software running on a device. Read-only
locationCode = The hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates: CA= Canada TOR=Toronto OF1=Office 1.
Note: The code is case-sensitive. It must be all UPPER CASE letters. The country code and child location code should be alphanumeric strings.
Both
locationInherited = This defines if the location property was defined directly on the object level or was inherited from the parent object. Read-only
IP4DHCPRange start = Start of the range. Both
end = End of the range. Both
offset = IPv4 address from which the range should begin. Both
size = the size of the range to be created. Both
defineRangeBy = the possible values are OFFSET_AND_SIZE and OFFSET_AND_PERCENTAGE. Both
IP4NetworkTemplate gateway = gateway of the network. Both
reservedAddress = the list of reserved addresses being set on the network template. Both