IPv4 objects - BlueCat Integrity - 9.3.0

Address Manager API Guide
Locale
English
Product name
BlueCat Integrity
Version
9.3.0

Object Type Properties Read-only/Updatable
IP4Block CIDR

The CIDR value of the block (if it forms a valid CIDR).

 Read-only
name

The name of the block.

 Both
defaultDomains

Comma-separated IDs of the default domains.

 Both
start

The start of the block (if it does not form a valid CIDR).

 Read-only
end

The end of the block (if it does not form a valid CIDR).

 Read-only
defaultView

The 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 hostname check option. There are three possible values for this property:

  • enable—set to enable the property and refuse duplicate hostnames.
  • disable—set to disable the property and allow duplicate hostnames.
    Note: This is the default value for allowDuplicateHost.
  • inherit—set to make the hostname use the option specified in the higher-level parent object.
 Both
pingBeforeAssign

Option to ping check. The possible values are enable and disable.

 Both
inheritAllowDuplicateHost

Duplicate hostnames inheritance check option property. The possible values are true and false.

If true, the allowDuplicateHost option set at the parent object level will be used. If false, you must specify the allowDuplicateHost option and the specified value will be used.

 Both
inheritPingBeforeAssign

PingBeforeAssign option inheritance check option property. The possible values are true and false.

If true, the PingBeforeAssign option set at the parent object level will be used. If false, you must specify the PingBeforeAssign and the specified value will be used.

 Both
inheritDNSRestrictions

The possible values are true and 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, you must specify the DNSRestrictions option and the specified value will be used.

 Both
inheritDefaultDomains

The possible values are true and false.

If true, the IDs of the default domain will be inherited from the parent object. If false, you must specify the defaultDomains option and the specified value will be used.

 Both
inheritDefaultView

The possible values are true and false.

If true, the ID of the default view for the block will be inherited from the parent object. If false, you must specify the defaultView option and the specified value 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 and must be in uppercase letters. The country code and child location code should be alphanumeric strings.
 Both
locationInherited

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

The 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 and disable.

 Both
pingBeforeAssign

Ping check option property. The possible values are enable and disable.

 Both
inheritAllowDuplicateHost

Duplicate host names inheritance check option property. The possible values are true and false.

If true, the allowDuplicateHost option set at the parent object level will be used. If false, you must specify the allowDuplicateHost option and the specified value will be used.

 Both
inheritPingBeforeAssign

PingBeforeAssign option inheritance check option property. The possible values are true and false.

If true, the PingBeforeAssign option set at the parent object level will be used. If false, you must specify the PingBeforeAssign option and the specified value will be used.

 Both
inheritDNSRestrictions

The possible values are true and 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, you must specify the DNSRestrictions option and the specified value will be used.

 Both
inheritDefaultDomains

The possible values are true and false.

If true, the IDs of the default domain will be inherited from the parent object. If false, you must specify the defaultDomains and the specified value will be used.

 Both
inheritDefaultView

The possible values are true and false.

If true, the ID of the default view for the block will be inherited from the parent object. If false, you must specify the defaultView option and the specified value 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 and must be in uppercase letters. The country code and child location code should be alphanumeric strings.
 Both
locationInherited

Defines if the location property was defined directly on the object level or was inherited from the parent object.

 Read-only
sharedNetwork

The name of the shared network tag object associated with the IP4 network object.

 Read-only
IP4Address address

Address string.

 Read-only
state

IP address state. For possible values, refer to IP address states.

 Read-only
macAddress

MAC address of the IPv4 address.

 Both
routerPortInfo

Connected router port information for the IPv4 address.

 Read-only
switchPortInfo

Connected switch port information for the IPv4 address.

 Read-only
vlanInfo

VLAN information for the IPv4 address.

 Read-only
ptrs

A string providing unmanaged external host records with which the IPv4 address will be associated, displayed in the format: 

viewId,exHostFQDN[, viedId,exHostFQDN,...]
 Write-only
leaseTime

The time when the IP address was leased.

 Read-only
expiryTime

The date and time that the DHCP lease expires (applies only to DHCP Allocated IP addresses).

 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 and must be in uppercase 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
reservedAddresses
Comma-separated list of values in the following form: 
{type,definedBy,offset,size,direction,name,
entityId,splitStaticAddresses}

For example: 

gateway=10|reservedAddresses=
{RESERVED_DHCP_RANGE,10,11,FROM_END,a,100990,
false},{RESERVED_DHCP_RANGE,
OFFSET_AND_PERCENTAGE,9,14,FROM_END,b,100991,
false}|
 Both