Add IPv4 Reconciliation Policy - BlueCat Address Manager - 9.0.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.0.0

Adds an IPv4 reconciliation policy.

Output / Response

Adds an IPv4 reconciliation policy.

API call:

long addIP4ReconciliationPolicy ( long parentId, string name, string properties )
Parameter Description
parentId The object ID of the parent network of the policy. You can create IPv4 reconciliation policies at the configuration, IPv4 block or IPv4 network levels.
name The name of the policy.
properties A string containing properties and values listed in List of properties and values.

List of properties and values

discoveryType A type of discovery method to use for the network discovery operation. This must be one of the constants listed in IP Discovery Type.
seedRouterAddress IPv4 address. This is not the Default Gateway Address.
snmpVersion Constants defined in SNMP Version. This must be one of the constants listed in SNMP Version.
snmpPortNumber An integer greater than 0.
snmpCommunityString Strings separated by comma (,). For example, community10,community12,community13.
securityLevel This must be one of the constants listed in SNMP Security Levels.
context A string. This is required only when snmpVersion is v3.
authenticationType Constants defined in SNMP Authentication Type. This must be one of the constants listed in SNMP Authentication Type. This is required only when securityLevel is AUTH_NOPRIV or AUTH_PRIV.
authPassphrase A string. This is required only when securityLevel is AUTH_NOPRIV or AUTH_PRIV.
privacyType A string containing the privacy encryption types. This must be one of the constants listed in SNMP Privacy Type. This is required only when securityLevel is AUTH_PRIV.
privacyPassphrase A string containing the privacy authentication password. This is required only when securityLevel is AUTH_PRIV.
networkBoundaries IPv4 ranges separated by comma(,). CIDR and IPv4 range formats are supported. For example, 10.0/8,13.0.0.1-13.0.0.126.
blackHoleVlan VLAN ID for the black hole VLAN. This is used as a default VLAN for all unused ports.
trunkDefaultVlan Unused VLAN ID to be assigned to a trunk as a native/default VLAN to protect controlled traffic from being spoofed.
skipFqdn True or false. This is used to determine whether Address Manager discovery engine to perform FQDN resolution and DNS lookups against any DNS server.
dnsServers One or more IPv4 or IPv6 address separated by comma (,). This is used to perform FQDN and DNS reverse lookups.
enableLayer2Discovery True or false.
schedule Schedule settings:
  • Format: hh:mma,dd MMM yyyy, frequencyType
  • frequency: frequencyPeriod
  • frequencyType: EVERY or ONCE
  • frequency: an integer greater than 0
  • frequencyPeriod: constant defined in TimeUnits which includes [MINUTES|HOURS|DAYS]
For example, 03:37am,31 May 2011,EVERY,6,Days
activeStatus True or false.
acceptanceCriteriaReclaim Used to enable automated acceptance. acceptanceCriteriaReclaim, acceptanceCriteriaUnknown, acceptanceCriteriaMismatch and view should be used together as a complete configuration.
  • Format: timeValue, timeUnit, actionType
  • timeValue: a integer greater than 0
  • timeUnit: constant defined in timeUnits which includes [MINUTES|HOURS|DAYS]
  • actionType: constant defined in AcceptanceActionType which includes [RECONCILE, NOACTION]
For example, 10,MINUTES,RECONCILE
acceptanceCriteriaUnknown Used to enable automated acceptance.
  • Format: timeValue, timeUnit, actionType
  • timeValue: a integer greater than 0
  • timeUnit: constant defined in timeUnits which includes [MINUTES|HOURS|DAYS]
  • actionType: constant defined in AcceptanceActionType which includes [RECONCILE, NOACTION]
For example, 20,HOURS,NOACTION
acceptanceCriteriaMismatch Used to enable automated acceptance.
  • Format: timeValue, timeUnit,actionType
  • timeValue: a integer greater than 0
  • timeUnit: constant defined in timeUnits which includes [MINUTES|HOURS|DAYS]
  • actionType: constant defined in AcceptanceActionType which includes [RECONCILE, NOACTION]
For example, 30,MINUTES,RECONCILE
view This is used if a user wants to enable the automated acceptance for an existing view’s name.
overrideList IPv4 ranges separated by comma(,). CIDR and IP4 range formats are supported. For example, 10/16,172/16,172.25.0.2-172.25.0.18.