General
Many Men & Mice Central properties and methods are available through Simple Object Access Protocol (SOAP) commands. You can use the following URL to retrieve a list of supported SOAP services and WSDL (Web Services Definition Language):
Windows:
http://service_hostname:port/_mmwebext/mmwebext.dll?WSDL?server=mmcentral_server_hostname
Unix:
http://service_hostname:port/Soap?WSDL?server=mmcentral_server_hostname
- service_hostname is the fully qualified domain name of the web server that is running the SOAP service.
- mmcentral_server_hostname is the fully qualified domain name of the server that is running Men & Mice Central.
- port is the port number to use for the web server that is running the SOAP service. The default port number is 80.
Authorization
To run the SOAP commands, you must have the required access rights. You must be granted access to the Men & Mice Web interface to be able to use any of the SOAP commands.
Error handling
If an error occurs when performing an action (for example if referring to a non-existing object or when trying to perform an action on an object without sufficient access privileges) an error message is returned. The error message uses the SOAP Fault message format. For further information see:
http://www.w3schools.com/SOAP/soap_fault.asp
Referencing objects
All objects in the Men & Mice Suite have a reference ID, ref, of type ObjRef. The reference is an ID that uniquely identifies an object in the Men & Mice Suite and is used to identify the object to be worked on.
A reference can either be a globally unique identifier (GUID), returned by the M&M Suite, or an object name. All functions in the SOAP interface try to resolve the reference intelligently, based on context. Functions working on more than one object type have an optional ObjType parameter that can be specified when an object is referenced by name, but which is not needed when a GUID is passed to them.
Since object names are not guaranteed to be unique, using GUIDs is the only way to guarantee that the M&M Suite will find the object. If more than one object have the same name, using that name as an object reference will cause an error.
Example:
uint count = 0;
MMSOAP.Property[] props;
// This will fail because GetProperties() does not know the type of "my.zone."
props = mmSoap.GetProperties(mySession, "my.zone.", MMSOAP.ObjectType.Unknown, false, false, false);
// This will fail if there are multiple zones with the name "my.zone."
props = mmSoap.GetProperties(mySession, "my.zone.", ObjectType.DNSZone, true, false, false);
// This will select the first instance of "my.zone." to work on
MMSOAP.DNSZone[] zones = mmSoap.GetDNSZones(mySession, "name:my.zone.", 0, false, 0, false, "name", MMSOAP.SortOrder.Ascending, true, out count);
props = mmSoap.GetProperties(mySession, zones[0].@ref, MMSOAP.ObjectType.Unknown, false, false, false);
For object types where the "name" element can be non-unique, if a command is called giving an object reference, which is a non-unique name, an exception is thrown stating that the specified reference matches multiple objects.
But even for (some of) these object types, there is a way to reference objects with non-unique names:
- For zones, the reference can be in the format
[[servername:]viewname:]zonename
- For scopes, the reference can be in the format or
- For views, the reference can be in the format
For example, to delete a zone called test.com. from the default view on server dns1.com:
<RemoveObject>
<ref>dns1.com.::test.com.</ref>
<objType>DNSZone</objType>
</RemoveObject>
Filtering
Some commands contain a filter element. This element can be used to filter results when getting a list of objects.
The filter has the following format:
[["]property["]:]["][!][^]text[$]["][
[["]property["]:]["][!][^]text[$]["]]*
Where the "!" sign means does-not-match, the "^" sign means starts-with, and the "$" sign means ends-with.
Examples:
Filtering by string "mycorp" on all properties, you simply have:
Filtering by string "mycorp" on property "name", you have:
<filter>name:mycorp</filter>
Filtering by string starting with "mycorp" on property "name":
<filter>name:^mycorp</filter>
Filtering by string not ending with "mycorp" on property "name":
<filter>name:!mycorp$</filter>
If the text must contain whitespace it must be quoted, so to filter by string not starting with "requested by" on property "comment":
<filter>comment:"!^requested by"</filter>
Same thing if the property name contains whitespace, so to filter by string "mycorp" on property "Company Name":
<filter>"Company Name":mycorp</filter>
When using a filter with GetDNSZones command, here's the filter to get all master zones, excluding reverse zones:
<filter>type:^Master$ name:!arpa.$</filter>
Getting only zones with name "domain.com.":
<filter>name:^domain.com.$</filter>
Getting only zones ending with name "domain.com.":
<filter>name:domain.com.$</filter>
Some examples that show the usage of a filter with the GetDNSRecords command. Remember that the command requires a dnsZoneRef element so you're always working relative to a specific zone. Here is the filter to get records having the name "time" from within the specified zone:
<filter>name:^time$</filter>
Getting all A records from within the specified zone:
<filter>type:^A$</filter>
Getting all records with data "ntp":
<filter>data:^ntp$</filter>
Getting all A records having the name "time":
<filter>type:^A$ name:^time$</filter>
Types
ADForest
Contains all properties for an AD Forest object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | No | No | The name of the AD Forest. |
catalogServer | string | No | Yes | Global catalog server to which the Men & Mice Suite connects for retrieving sites and subnets. |
userName | string | No | Yes | User name used when connecting to the global catalog server. |
password | string | No | Yes | Password used when connecting to the global catalog server. |
readOnly | boolean | No | No | Determines if the forest is read-only. |
ArrayOfADForest
Elements
ADReplicationType
Defines possible replication types for an AD integrated zone.
Enumerations
Name | Description |
---|
None | No replication. |
To_All_DNS_Servers_In_AD_Forrest | Replicate to all DNS servers in an AD forest. |
To_All_DNS_Servers_In_AD_Domain | Replicate to all DNS servers in an AD domain. |
To_All_Domain_Controllers_In_AD_Domain | Replicate to all domain controllers in an AD domain. |
To_All_Domain_Controllers_In_Specified_Partition | Replicate to all domain controllers in a specified partition. |
Unavailable | Replication is unavailable. |
ADSite
Contains all properties for an AD Site object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the AD Site. |
description | string | Yes | Yes | A description of the AD Site. |
location | string | Yes | Yes | The location of the AD Site. |
adForestRef | ObjRef | Yes | No | A reference to the AD Forest to which the AD Site belongs. |
ArrayOfADSite
Elements
ADSiteLink
Contains all properties for an AD Site Link object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the AD Site Link. |
description | string | No | Yes | A description of the AD Site Link. |
cost | unsignedInt | No | No | A metric used by AD to determine which site links have precedent over other site links |
replInterval | unsignedInt | No | No | Replication interval. Defines the interval (in minutes) between performing AD replications. |
siteList | ArrayOfString | No | Yes | List of AD Sites that this Site Link links together. |
adForestRef | ObjRef | Yes | No | A reference to the AD Forest to which the AD Site Link belongs. |
ArrayOfADSiteLink
Elements
AccessEntry
Contains the name and setting for an access entry relevant to an object.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the access entry. |
access | AccessType | Yes | No | The setting for the access entry. |
ArrayOfAccessEntry
Elements
AccessType
Defines possible access for an object property.
Enumerations
Name | Description |
---|
Unspecified | No access specified. |
Allow | Allow access. |
Deny | Deny access. |
Address
Contains all properties for an address.
Elements
Name | Type | Required | Nillable | Description |
---|
id | unsignedInt | Yes | No | Unique identifier for the address. |
address | string | Yes | No | The address. |
claimed | boolean | Yes | No | Determines whether the address is claimed. |
host | string | Yes | Yes | Comma separated list of fully qualified DNS host names associated with the address. |
lastseen | unsignedInt | Yes | No | Timestamp when the address was last seen during discovery (ping). |
lastdiscovery | unsignedInt | Yes | No | Timestamp when discovery (ping) was last performed for the address. |
customProperties | ArrayOfProperty | Yes | Yes | The custom properties for the address. |
ArrayOfAddress
Elements
AddressBlock
Contains all properties for an address block.
Elements
Name | Type | Required | Nillable | Description |
---|
from | IPAddress | Yes | No | The starting IP address of the address block. |
to | IPAddress | Yes | No | The ending IP address of the address block. |
ArrayOfAddressBlock
Elements
AddressSpace
Contains all properties for an address space object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the address space. |
description | string | No | Yes | A description of the address space. |
ArrayOfAddressSpace
Elements
AddressUtilizationHistory
Address utilization data that has been aggregated by date.
Elements
Name | Type | Required | Nillable | Description |
---|
timestamp | unsignedInt | Yes | No | Timestamp that includes the date aggregated by. |
measurecount | unsignedInt | Yes | No | The number of measurements that were aggregated. |
mean | unsignedInt | Yes | No | The mean of aggregated numbers |
max | unsignedInt | Yes | No | The max of aggregated numbers. |
min | unsignedInt | Yes | No | The min of aggregated numbers. |
AddressUtilizationHistorySeries
Contains address utilization data that has been aggregated as part of history calculations.
Elements
Name | Type | Required | Nillable | Description |
---|
isdynamic | unsignedInt | Yes | No | States if the data is for the static or dynamic part of an address range. |
size | unsignedInt | Yes | No | Total number of addresses for the requested address range. |
availableAddresses | unsignedInt | Yes | No | Number of available addresses within an address range. |
addressUtilizationHistory | AddressUtilizationHistory | No | No | Address utilization data aggregated by date. |
AddressUtilizationRecent
Address utilization measurement.
Elements
Name | Type | Required | Nillable | Description |
---|
timestamp | unsignedInt | Yes | No | Timestamp that signals when the measurements were taken. |
value | unsignedInt | Yes | No | The number of addresses in use. |
AddressUtilizationRecentSeries
Contains recent address utilization data which gives information about each measurement made, these numbers will be aggregated together at a certain age for space saving reasons.
Elements
Name | Type | Required | Nillable | Description |
---|
isdynamic | unsignedInt | Yes | No | States if the data is for the static or dynamic part of an address range. |
size | unsignedInt | Yes | No | Total number of addresses for the requested address range. |
availableAddresses | unsignedInt | Yes | No | Number of available addresses within an address range. |
addressUtilizationRecent | AddressUtilizationRecent | No | No | Address utilization measurement. |
ApplianceState
Defines possible Appliance states.
Enumerations
Name | Description |
---|
Unknown | Unknown appliance state. |
OK | Appliance is OK. |
Unreachable | Appliance is offline or otherwise unreachable. |
Out of date | Appliance has a different version than Central. |
Wrong type | Appliance is of a wrong type. |
Updating | Appliance is being updated. |
Service Down | Appliance is down and not responding. |
AuthenticationType
Defines possible authentication types for a user that is logging in.
Enumerations
Name | Description |
---|
Internal | Internal authentication. |
AD | Active Directory authentication. |
ADGroup | Active Directory group-level authentication. |
RADIUS | RADIUS authentication. |
CachedDNSEntry
Contains an entry from a DNS cache.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the DNS record. |
data | string | Yes | No | Contains the record data in a tab-separated list. |
ArrayOfCachedDNSEntry
Elements
ChangeRequest
Contains all properties for a change request object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
requester | string | Yes | No | The name of the user that made the change request. |
state | ChangeRequestState | Yes | No | The state of the change request. |
creationDate | DateTime | Yes | No | The date and time, when the change request was created. |
objType | ObjectType | Yes | No | The type of object being requested. Currently limited to DNSRecord and DHCPReservation objects. |
requestDate | DateTime | No | No | The date and time, when the change request should be applied, if specified. |
customProperties | ArrayOfProperty | Yes | Yes | The custom properties for the change request. |
saveComment | string | Yes | Yes | Save comment text to associate with the action. |
processedDate | DateTime | No | No | The date and time, when the change request was approved or rejected. |
dnsRecordChanges | ArrayOfDNSRecordChange | No | No | DNS record changes associated with the change request. |
dhcpScopeChanges | ArrayOfDHCPScopeChange | No | No | DHCP scope changes associated with the change request. |
dhcpReservationChanges | ArrayOfDHCPReservationChange | No | No | DHCP reservation changes associated with the change request. |
dhcpExclusionChanges | ArrayOfDHCPExclusionChange | No | No | DHCP exclusion changes associated with the change request. |
dhcpAddressPoolChanges | ArrayOfDHCPAddressPoolChange | No | No | DHCP address pool changes associated with the change request. |
dhcpOptionChanges | ArrayOfDHCPOptionChange | No | No | DHCP option changes associated with the change request. |
ArrayOfChangeRequest
Elements
ChangeRequestState
Defines possible change request states.
Enumerations
Name | Description |
---|
Pending | Pending approval/rejection. |
Approved | Approved, waiting to be applied. |
Rejected | Rejected. |
Applied | Applied. |
Failed | Failed to be applied. |
ChangeType
Defines possible change types.
Enumerations
Name | Description |
---|
Add | Add. |
Modify | Modify. |
Remove | Remove. |
Cloud
Contains all properties for a cloud object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the cloud. |
type | CloudType | Yes | No | The type of the cloud. |
serverNode | string | Yes | No | The server node with which to communicate. |
username | string | Yes | No | The username to use for authenticating with cloud. |
password | string | Yes | Yes | The password to use for authenticating with cloud. |
httpsRequired | boolean | Yes | No | Is HTTPS required for communicating with server node. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the cloud. |
ArrayOfCloud
Elements
CloudNetwork
Contains all properties for a cloud network object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the cloud network. |
cloudRef | ObjRef | Yes | No | Reference for the cloud to which the cloud network belongs. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the cloud network. |
ArrayOfCloudNetwork
Elements
CloudSubnet
Contains all properties for a cloud subnet associated with a range.
Elements
Name | Type | Required | Nillable | Description |
---|
rangeRef | ObjRef | Yes | No | Reference to the address range associated with the cloud subnet. |
allocationPools | ArrayOfAddressBlock | No | Yes | Specifies addresses in subnet which should be available for dynamic allocation. If omitted/empty when placing subnet in cloud network, defaults to all addresses in subnet. |
ArrayOfCloudSubnet
Elements
CloudType
Defines possible cloud types.
Enumerations
Name | Description |
---|
Unknown | Unknown cloud type. |
OpenStack | OpenStack cloud. |
CloudStack | CloudStack cloud |
CustomFilter
Contains all properties for a custom filter object.
Elements
Name | Type | Required | Nillable | Description |
---|
id | unsignedInt | No | No | A unique ID for the object. |
type | unsignedInt | No | No | The object type for the filter. |
name | string | Yes | No | The name of the filter. |
filter | string | Yes | No | The filter string. |
folderRef | string | No | Yes | If the filter is in a folder, then this is a valid folder reference. If the filter is not in a folder, then this is an empty string. |
readOnly | boolean | Yes | No | Is the filter read only? |
ArrayOfCustomFilter
Elements
DCHPScopeOptionsReportEntry
Contains information about DHCP scopes returned by DHCP scope options report.
Elements
Name | Type | Required | Nillable | Description |
---|
dhcpServerName | string | Yes | No | The name of the DHCP server containing the DHCP scope. |
dhcpScopeName | string | Yes | No | The name of the DHCP scope. |
optionValue | string | Yes | Yes | The option value set for the DHCP scope. |
inherited | boolean | Yes | No | Specifies whether the option value is inherited. |
ArrayOfDCHPScopeOptionsReportEntry
Elements
DHCPAddressPool
Contains all properties for a DHCP address pool object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | No | No | The name of the DHCP address pool. |
from | IPAddress | No | No | The start address of the DHCP address pool. |
to | IPAddress | No | No | The end address of the DHCP address pool. |
failoverPeer | string | No | No | The name of the failover peer if the address pool is on an ISC DHCP server with failover peer(s) defined. |
failoverRelationship | string | No | No | The name of the failover relationship if the address pool is on an MS DHCP server with failover(s) defined. Read-only property. |
dhcpScopeRef | ObjRef | Yes | No | A unique reference ID of the scope that contains the address pool. |
ArrayOfDHCPAddressPool
Elements
DHCPAddressPoolChange
Contains all properties for a DHCP address pool change object.
Elements
Name | Type | Required | Nillable | Description |
---|
type | ChangeType | Yes | No | The type of the DHCP address pool change. |
state | ChangeRequestState | No | No | The state of the DHCP address pool change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DHCP address pool change. |
changeIndex | unsignedInt | No | No | The index of the DHCP address pool change within the change request which contains the DHCP address pool change. |
dhcpAddressPoolBefore | DHCPAddressPool | No | No | The DHCP address pool as it was when the DHCP address pool change was made (omitted when type is Add). |
dhcpAddressPoolAfter | DHCPAddressPool | No | No | The DHCP address pool as it should be after the DHCP address pool change has been applied (omitted when type is Remove). |
ArrayOfDHCPAddressPoolChange
Elements
DHCPAddressPoolPermit
Contains all properties for a DHCP address pool permit object.
Elements
Name | Type | Required | Nillable | Description |
---|
permit | DHCPAddressPoolPermitType | Yes | No | The DHCP address pool permit type. |
access | AccessType | Yes | No | The DHCP address pool access type. |
className | string | No | No | The name of the DHCP class if permit type is MembersOfDHCPClass. |
ArrayOfDHCPAddressPoolPermit
Elements
DHCPAddressPoolPermitType
Defines the types of DHCP Address Pool permits.
Enumerations
Name | Description |
---|
Unknown | Unknown DHCP address pool permit. |
AllClients | DHCP address pool permit for all clients. |
KnownClients | DHCP address pool permit for known clients. |
UnknownClients | DHCP address pool permit for unknown clients. |
DynamicBOOTPClients | DHCP address pool permit for dynamic BOOTP clients. |
MembersOfDHCPClass | DHCP address pool permit for members of a DHCP class. |
DHCPConcurrentLease
Contains information about a concurrent lease.
Elements
Name | Type | Required | Nillable | Description |
---|
dhcpServerRef | ObjRef | Yes | No | Reference to the DHCP server containing the concurrent lease. |
dhcpServerName | string | Yes | No | Name of the DHCP server containing the concurrent lease. |
dhcpScopeRef | ObjRef | Yes | No | Reference to the DHCP scope containing the concurrent lease. |
dhcpScopeName | string | Yes | No | Name of the DHCP scope containing the concurrent lease. |
name | string | Yes | Yes | Name of the concurrent lease. |
type | string | Yes | Yes | Type of the concurrent lease. |
mac | string | Yes | No | MAC address of the concurrent lease. |
address | IPAddress | Yes | No | IP address of the concurrent lease. |
lease | string | Yes | No | Duration of the concurrent lease. |
state | string | Yes | Yes | State of the concurrent lease. |
ArrayOfDHCPConcurrentLease
Elements
DHCPExclusion
Contains all properties for a DHCP exclusion object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | No | No | The name of the DHCP exclusion. |
from | IPAddress | No | No | The start address of the DHCP exclusion. |
to | IPAddress | No | No | The end address of the DHCP exclusion. |
dhcpScopeRef | ObjRef | Yes | No | A unique reference ID of the scope that contains the exclusion. |
ArrayOfDHCPExclusion
Elements
DHCPExclusionChange
Contains all properties for a DHCP exclusion change object.
Elements
Name | Type | Required | Nillable | Description |
---|
type | ChangeType | Yes | No | The type of the DHCP exclusion change. |
state | ChangeRequestState | No | No | The state of the DHCP exclusion change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DHCP exclusion change. |
changeIndex | unsignedInt | No | No | The index of the DHCP exclusion change within the change request which contains the DHCP exclusion change. |
dhcpExclusionBefore | DHCPExclusion | No | No | The DHCP exclusion as it was when the DHCP exclusion change was made (omitted when type is Add). |
dhcpExclusionAfter | DHCPExclusion | No | No | The DHCP exclusion as it should be after the DHCP exclusion change has been applied (omitted when type is Remove). |
ArrayOfDHCPExclusionChange
Elements
DHCPFailoverMode
Defines possible DHCP failover modes.
Enumerations
Name | Description |
---|
LoadBalance | Load Balance. |
HotStandby | Hot Standby. |
DHCPFailoverRelationship
Defines a DHCP failover relationship.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the DHCP failover relationship. |
primaryServer | string | Yes | No | The primary DHCP server. |
secondaryServer | string | Yes | No | The secondary DHCP server. |
failoverMode | DHCPFailoverMode | Yes | No | The DHCP failover mode to use. |
failoverServerType | DHCPFailoverServerType | Yes | No | A set of possible values for a DHCPv4 server in a failover relationship. |
mclt | unsignedInt | Yes | No | Maximum client lead time in seconds. |
safePeriod | unsignedInt | Yes | No | Safe period time in seconds, that the DHCPv4 server will wait before transitioning the server from the COMMUNICATION-INT state to PARTNER-DOWN. |
dhcpScopeRefs | ArrayOfObjRef | Yes | Yes | References to DHCP scopes that are associated with the failover relationship. |
percentage | unsignedInt | Yes | No | Indicates the ratio of the DHCPv4 client load shared between a primary and secondary server in the failover relationship. |
sharedSecret | string | No | No | The shared secret key associated with this failover relationship. |
ArrayOfDHCPFailoverRelationship
Elements
DHCPFailoverServerType
Defines the types of DHCP Failover server.
Enumerations
Name | Description |
---|
PrimaryServer | The server is a primary server in the failover relationship. |
SecondaryServer | The server is a secondary server in the failover relationship. |
DHCPGroup
Contains all properties for a DHCP group object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the DHCP group. |
parentRef | ObjRef | No | No | An object reference to the parent group of the DHCP group. |
ownerRef | ObjRef | Yes | No | A reference to the owning object. |
ArrayOfDHCPGroup
Elements
DHCPLease
Contains all properties for a DHCP lease object.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | Yes | The name of the lease. |
type | string | No | No | The DHCP lease type. |
mac | string | Yes | No | The MAC address of the host that holds the lease. |
address | IPAddress | Yes | No | The IP address of the lease. |
lease | string | Yes | No | The expiration date for the lease. |
state | string | Yes | Yes | The state of the lease. |
dhcpScopeRef | ObjRef | Yes | No | A unique reference ID of the scope that contains the lease. |
ArrayOfDHCPLease
Elements
DHCPLeaseField
Defines the fields of a DHCP lease.
Enumerations
Name | Description |
---|
IPAddress | IP address field. |
ClientIdentifier | Client identifier field. |
ServerAddress | Server address field. |
Hostname | Hostname field. |
Description | Description field. |
DHCPLeaseHistoryEntry
Contains information about a DHCP lease.
Elements
Name | Type | Required | Nillable | Description |
---|
serverAddress | string | Yes | No | The IP address of the server. |
eventCode | string | Yes | Yes | Event code. |
timestampfirst | DateTime | Yes | Yes | First timestamp associated with the DHCP lease. |
timestamplast | DateTime | No | Yes | Last timestamp associated with the DHCP lease. |
ipAddress | string | Yes | Yes | The IP address of the DHCP lease. |
clientidentifier | string | Yes | Yes | The client identifier of the DHCP lease. |
hostname | string | Yes | Yes | The hostname of the DHCP lease. |
numberOfOccurrances | string | No | Yes | Number of occurrences of the DHCP lease. |
ArrayOfDHCPLeaseHistoryEntry
Elements
DHCPLeaseReference
Contains all properties for a DHCP lease.
Elements
Name | Type | Required | Nillable | Description |
---|
dhcpScopeRef | ObjRef | Yes | No | Reference to the DHCP scope that contains the lease. |
lease | IPAddress | Yes | No | IP address for the lease. |
ArrayOfDHCPLeaseReference
Elements
DHCPOption
Contains a single DHCP option value.
Elements
Name | Type | Required | Nillable | Description |
---|
option | string | Yes | No | The DHCP option ID. |
value | string | No | Yes | The DHCP option value. |
ArrayOfDHCPOption
Elements
DHCPOptionChange
Contains all properties for a DHCP option change object.
Elements
Name | Type | Required | Nillable | Description |
---|
state | ChangeRequestState | No | No | The state of the DHCP option change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DHCP option change. |
changeIndex | unsignedInt | No | No | The index of the DHCP option change within the change request which contains the DHCP option change. |
owner | Object | Yes | No | The owner (object) to which the DHCP option change should be applied. |
dhcpOption | DHCPOption | Yes | No | The DHCP option as it should be after the DHCP option change has been applied. |
ArrayOfDHCPOptionChange
Elements
DHCPOptionClass
Contains a definition for a DHCP option class.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The DHCP option class name. |
description | string | No | Yes | The DHCP option class description. |
identifier | string | Yes | No | The DHCP option class identifier. |
ArrayOfDHCPOptionClass
Elements
DHCPOptionDefinition
Contains a definition for a DHCP option.
Elements
Name | Type | Required | Nillable | Description |
---|
option | string | Yes | No | The DHCP option ID. |
name | string | Yes | No | The DHCP option name. |
type | PropertyType | Yes | No | The DHCP option type. |
array | boolean | Yes | No | Determines whether DHCP option is defined as an array. |
ArrayOfDHCPOptionDefinition
Elements
DHCPPolicy
Contains all properties for a DHCP policy.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the DHCP policy. |
description | string | No | Yes | A description for the DHCP policy. |
order | unsignedInt | No | No | Specifies the relative order in which the DHCP policy will be processed. |
enabled | boolean | No | No | Specifies whether the DHCP policy is enabled (default true). |
logicalOperator | DHCPPolicyLogicalOperator | Yes | No | The logical operation to be performed between the DHCP policy conditions. |
conditions | ArrayOfDHCPPolicyCondition | No | Yes | Conditions set for the DHCP policy. |
ranges | ArrayOfDHCPPolicyRange | No | Yes | IP ranges set for the DHCP policy. |
ArrayOfDHCPPolicy
Elements
DHCPPolicyComparisonType
Defines possible DHCP policy comparison types.
Enumerations
Name | Description |
---|
Equal | Comparison of whether values are equal. |
NotEqual | Comparison of whether values are not equal. |
DHCPPolicyCondition
Contains all properties for a DHCP policy condition.
Elements
Name | Type | Required | Nillable | Description |
---|
conditionType | DHCPPolicyConditionType | Yes | No | The type of the DHCP policy condition. |
comparisonType | DHCPPolicyComparisonType | Yes | No | The type of comparison to be performed on the DHCP policy condition attribute. |
values | ArrayOfString | Yes | No | The value(s) to be used for the DHCP policy condition comparison. Each value can end with wildcard character '*'. |
ArrayOfDHCPPolicyCondition
Elements
DHCPPolicyConditionType
Defines possible DHCP policy condition types.
Enumerations
Name | Description |
---|
MACAddress | MAC address. |
VendorClass | Vendor class. |
UserClass | User class. |
ClientIdentifier | Client identifier. |
RelayAgentInformation | Relay agent information. |
RAIAgentCircuitID | Relay agent information - Agent circuit ID. |
RAIAgentRemoteID | Relay agent information - Agent remote ID. |
RAISubscriberID | Relay agent information - Subscriber ID. |
DHCPPolicyLogicalOperator
Defines possible DHCP policy logical operators.
Enumerations
Name | Description |
---|
LogicalOr | Logical OR operator. |
LogicalAnd | Logical AND operator. |
DHCPPolicyRange
Contains all properties for a DHCP policy range.
Elements
Name | Type | Required | Nillable | Description |
---|
from | IPAddress | Yes | No | The starting IP address of the DHCP policy range. |
to | IPAddress | Yes | No | The ending IP address of the DHCP policy range. |
ArrayOfDHCPPolicyRange
Elements
DHCPRefAndFailoverRelationshipName
A DHCP failover relationship to remove.
Elements
Name | Type | Required | Nillable | Description |
---|
dhcpServerRef | ObjRef | No | No | An object reference for the DHCP server. |
dhcpFailoverRelationshipName | string | Yes | Yes | Name of the DHCP failover relationship to remove. |
DHCPReservation
Contains all properties for a DHCP reservation object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | Yes | The name of the reservation. |
clientIdentifier | string | No | Yes | The client identifier used for the reservation (e.g. the MAC address). |
addresses | ArrayOfIPAddress | No | Yes | An array of zero or more IP addresses used for the reservation. |
type | DHCPReservationType | No | No | The type of the DHCP reservation. |
reservationMethod | DHCPReservationMethod | No | No | The method used to identify the DHCP reservation. |
description | string | No | Yes | Description for the reservation. Only applicable for MS DHCP servers. |
ddnsHostName | string | No | Yes | Dynamic DNS host name for reservation. Only applicable for ISC DHCP servers. |
filename | string | No | Yes | The "filename" DHCP option. Only applicable for ISC DHCP servers. |
serverName | string | No | Yes | The "server-name" DHCP option. Only applicable for ISC DHCP servers. |
nextServer | string | No | Yes | The "next-server" ISC DHCP option. Only applicable for ISC DHCP servers. |
ownerRef | ObjRef | Yes | No | A unique reference ID of the DHCP server, group or scope that contains the reservation. |
ArrayOfDHCPReservation
Elements
DHCPReservationChange
Contains all properties for a DHCP reservation change object.
Elements
Name | Type | Required | Nillable | Description |
---|
type | ChangeType | Yes | No | The type of the DHCP reservation change. |
state | ChangeRequestState | No | No | The state of the DHCP reservation change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DHCP reservation change. |
changeIndex | unsignedInt | No | No | The index of the DHCP reservation change within the change request which contains the DHCP reservation change. |
dhcpReservationBefore | DHCPReservation | No | No | The DHCP reservation as it was when the DHCP reservation change was made (omitted when type is Add). |
dhcpReservationAfter | DHCPReservation | No | No | The DHCP reservation as it should be after the DHCP reservation change has been applied (omitted when type is Remove). |
ArrayOfDHCPReservationChange
Elements
DHCPReservationMethod
Defines possible DHCP reservation methods.
Enumerations
Name | Description |
---|
HardwareAddress | Hardware address. |
ClientIdentifier | Client identifier. |
DHCPReservationType
Defines possible DHCP reservation types.
Enumerations
Name | Description |
---|
DHCP | DHCP reservation type. |
BOOTP | BOOTP reservation type. |
BOTH | Both DHCP and BOOTP reservation types. |
DHCPScope
Contains all properties for a DHCP scope object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the DHCP scope. |
rangeRef | ObjRef | Yes | No | A reference to the range associated with the scope. |
dhcpServerRef | ObjRef | Yes | No | A reference to the DHCP server containing the scope. |
superscope | string | No | Yes | The name of the superscope for the DHCP scope. Only applicable for MS DHCP servers. |
description | string | No | Yes | A description for the DHCP scope. |
available | unsignedInt | No | No | Number of available addresses in the address pool(s) of the scope. |
enabled | boolean | No | No | Specifies whether the scope is enabled (default true). |
ArrayOfDHCPScope
Elements
DHCPScopeChange
Contains all properties for a DHCP scope change object.
Elements
Name | Type | Required | Nillable | Description |
---|
type | ChangeType | Yes | No | The type of the DHCP scope change. |
state | ChangeRequestState | No | No | The state of the DHCP scope change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DHCP scope change. |
changeIndex | unsignedInt | No | No | The index of the DHCP scope change within the change request which contains the DHCP scope change. |
dhcpScopeBefore | DHCPScope | No | No | The DHCP scope as it was when the DHCP scope change was made (omitted when type is Add). |
dhcpScopeAfter | DHCPScope | No | No | The DHCP scope as it should be after the DHCP scope change has been applied (omitted when type is Remove). |
ArrayOfDHCPScopeChange
Elements
DHCPScopeOptionsReportType
Defines possible DHCP scope options report types.
Enumerations
Name | Description |
---|
HasValue | Report on DHCP scopes that have the specified value for the specified DHCP option. |
DoesNotHaveValue | Report on DHCP scopes that do not have the specified value for the specified DHCP option. |
HasNoValueSet | Report on DHCP scopes that have no value set for the specified DHCP option. |
DHCPScopeReconcileEntry
Contains information about DHCP scope reconcile entries.
Elements
Name | Type | Required | Nillable | Description |
---|
scopeAddress | IPAddress | Yes | No | The IP address of the DHCP scope. |
address | IPAddress | Yes | No | The IP address that requires reconciling. |
flag | DHCPScopeReconcileFlag | Yes | Yes | The DHCP scope reconcile flag set for this entry. |
ArrayOfDHCPScopeReconcileEntry
Elements
DHCPScopeReconcileFlag
Defines possible DHCP scope reconcile flags.
Enumerations
Name | Description |
---|
ReconcileRegistry | Entry found in database but not in registry. |
ReconcileDatabase | Entry found in registry but not in database. |
DHCPServer
Contains all properties for a DHCP server object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the DHCP server. |
proxy | string | No | No | The DHCP server controller used to connect to the DHCP server. |
address | IPAddress | No | No | The IP address of the DHCP server. |
resolvedAddress | IPAddress | No | No | The IP address of the DHCP server, if specified, or the IP address retrieved through resolving the name of the DHCP server. |
username | string | No | Yes | The login name of the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers. |
password | string | No | Yes | The password for the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers. |
enablePassword | string | No | Yes | The password for entering maintenance mode when accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers. |
type | DHCPServerType | Yes | No | The DHCP server type. |
state | DHCPServerState | No | No | The state of the DHCP Server. |
security | DHCPServerSecurity | No | Yes | The login method used for the DHCP server. Only applicable for Cisco IOS DHCP servers. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the DHCP server. |
ArrayOfDHCPServer
Elements
DHCPServerSecurity
Defines possible login methods for Cisco IOS DHCP servers.
Enumerations
Name | Description |
---|
Unknown | Unknown login method. |
Telnet | Login using Telnet. |
SSH2 | Login using SSH2. |
DHCPServerState
Defines possible DHCP server states.
Enumerations
Name | Description |
---|
Unknown | Unknown DHCP server state. |
OK | DHCP Server is OK. |
Unreachable | DHCP Server Controller is offline or otherwise unreachable. |
Out of date | DHCP Server Controller has a different version than Central. |
Wrong type | DHCP Server type does not match type specified. |
Updating | DHCP Server Controller version is being updated. |
Service Down | DHCP server service is down and DHCP server is not answering clients. |
DHCPServerType
Defines possible DHCP server types.
Enumerations
Name | Description |
---|
Unknown | Unknown DHCP server. |
MSDHCP | Microsoft DHCP server. |
ISC | ISC DHCP server. |
IOS | Cisco IOS DHCP server. |
DNSCache
Contains a list of cached DNS entries, the view they belong to and a reference to the DNS server that the records are cached on.
Elements
Name | Type | Required | Nillable | Description |
---|
dnsServerRef | ObjRef | Yes | No | A reference to the DNS server containing the cached DNS records. |
cachedDNSEntries | ArrayOfCachedDNSEntry | Yes | No | DNS entries cached on the server. |
dnsViewRef | ObjRef | Yes | No | Contains the reference ID of the DNS view that the DNS records belong to. |
ArrayOfDNSCache
Elements
DNSGenerateDirective
Contains all properties for a DNS generate directive.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
rangeStart | unsignedInt | Yes | No | The start of the range. |
rangeEnd | unsignedInt | Yes | No | The end of the range. |
rangeStep | unsignedInt | No | No | The stepping of the range. Defaults to 1. |
lhs | string | Yes | Yes | The owner name of the resource records generated by the directive. |
ttl | string | No | Yes | The ttl of the resource records generated by the directive. |
class | string | No | Yes | The class of the resource records generated by the directive. |
type | DNSRecordType | Yes | No | The type of the resource records generated by the directive. |
rhs | string | Yes | Yes | The data of the resource records generated by the directive. |
ArrayOfDNSGenerateDirective
Elements
DNSHost
Contains all properties for a DNS host object. A DNS host is an address (A) record and all CNAME, TXT and MX records that are associated with the record.
Elements
Name | Type | Required | Nillable | Description |
---|
dnsRecord | DNSRecord | Yes | No | The DNS host record. The record must be an address (A) record. Note that the name element of the record is fully qualified here. |
ptrStatus | PTRStatus | No | No | The PTR record status for the host record. |
relatedRecords | ArrayOfDNSRecord | Yes | Yes | An array of records associated with the host record. |
ArrayOfDNSHost
Elements
DNSRecord
Contains all properties for a DNS record object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | Yes | The name of the DNS record, either partially or fully qualified. |
type | DNSRecordType | Yes | No | Specifies the type of the DNS record. |
ttl | string | Yes | Yes | Specifies the Time-To-Live of the DNS record. |
data | string | Yes | Yes | Contains the record data in a tab-separated list. |
comment | string | No | Yes | Contains the comment string for the record. Note that only records in static DNS zones can have a comment string. |
enabled | boolean | Yes | No | Contains true if the record is enabled. If the record is disabled the value is false. |
aging | unsignedInt | No | No | The aging timestamp of dynamic records in AD integrated zones. |
dnsZoneRef | ObjRef | Yes | No | Contains the reference ID of the zone that contains the record. |
ArrayOfDNSRecord
Elements
DNSRecordChange
Contains all properties for a DNS record change object.
Elements
Name | Type | Required | Nillable | Description |
---|
type | DNSRecordChangeType | Yes | No | The type of the DNS record change. |
state | ChangeRequestState | No | No | The state of the DNS record change. |
hasAccess | boolean | No | No | Specifies whether the user has access to approve/reject the DNS record change. |
changeIndex | unsignedInt | No | No | The index of the DNS record change within the change request which contains the DNS record change. |
dnsRecordBefore | DNSRecord | No | No | The DNS record as it was when the DNS record change was made (omitted when type is AddDNSRecord). |
dnsRecordAfter | DNSRecord | No | No | The DNS record as it should be after the DNS record change has been applied (omitted when type is RemoveDNSRecord). |
ArrayOfDNSRecordChange
Elements
DNSRecordChangeRequest
Contains all properties for a DNS record change request object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
requester | string | Yes | No | The name of the user that made the change request. |
state | ChangeRequestState | Yes | No | The state of the change request. |
creationDate | DateTime | Yes | No | The date and time, when the change request was created. |
requestDate | DateTime | No | No | The date and time, when the change request should be applied, if specified. |
customProperties | ArrayOfProperty | Yes | Yes | The custom properties for the change request. |
saveComment | string | Yes | Yes | Save comment text to associate with the action. |
processedDate | DateTime | No | No | The date and time, when the change request was approved or rejected. |
dnsRecordChanges | ArrayOfDNSRecordChange | No | No | The DNS record changes associated with the change request. |
ArrayOfDNSRecordChangeRequest
Elements
DNSRecordChangeType
Defines possible DNS record change types.
Enumerations
Name | Description |
---|
AddDNSRecord | Add DNS record. |
ModifyDNSRecord | Modify DNS record. |
RemoveDNSRecord | Remove DNS record. |
DNSRecordType
Defines possible DNS record types.
Enumerations
Name | Description |
---|
Any | Any record type. |
Unknown | Unknown record type. |
A | A (Address) record. |
NS | NS (Name Server) record. |
CNAME | CNAME (Canonical Name) record. |
SOA | SOA (Start Of Authority) record. |
WKS | WKS (Well Known Services) record. |
PTR | PTR (Pointer) record. |
HINFO | HINFO (Host Information) record. |
MX | MX (Mail Exchange) record. |
TXT | TXT (Text) record. |
SPF | SPF (Sender Policy Framework) record. |
RP | RP (Responsible Person) record. |
AFSDB | AFSDB (AFS Database) record. |
AAAA | AAAA (IPv6 address) record. |
LOC | LOC (Location) record. |
SRV | SRV (Service Locator) record. |
NAPTR | NAPTR (Naming Authority Pointer) record. |
DNAME | DNAME (Delegation Name) record. |
WINS | WINS (Windows Internet Server Name) record. |
WINSR | WINSR (WINS Reverse Lookup) record. |
DS | DS (Delegation Signer) record. |
SSHFP | SSHFP (SSH Public Key Fingerprint) record. |
DHCID | DHCID (DHCP Identifier) record. |
CERT | CERT (Certificate) record. |
RRSIG | RRSIG (DNSSEC Signature) record. |
DNSKEY | DNSKEY (DNS Key) record. |
NSEC | NSEC (Next-Secure) record. |
NSEC3 | NSEC3 (NSEC version 3) record. |
NSEC3PARAM | NSEC3PARAM (NSEC3 parameters) record. |
TLSA | TLSA (DANE) record |
DNSServer
Contains all properties for a DNS server object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the DNS server. |
proxy | string | No | No | The DNS server controller used to connect to the DNS server. |
address | IPAddress | No | No | The IP address of the DNS server. |
resolvedAddress | IPAddress | No | No | The IP address of the DNS server, if specified, or the IP address retrieved through resolving the name of the DNS server. |
port | unsignedInt | No | No | The port to use when connecting to the DNS server. Only needed if a non-standard port is used to connect to the server. |
type | DNSServerType | Yes | No | The type of DNS server. |
adForest | string | No | No | The name of the AD Forest with which the DNS server is associated. |
state | DNSServerState | No | No | The state of the DNS Server. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the DNS server. |
subtype | DNSServerSubtype | No | No | The subtype of DNS server. |
ArrayOfDNSServer
Elements
DNSServerState
Defines possible DNS server states.
Enumerations
Name | Description |
---|
Unknown | Unknown DNS server state. |
OK | DNS Server is OK. |
Unreachable | DNS Server Controller is offline or otherwise unreachable. |
Out of date | DNS Server Controller has a different version than Central. |
Uninitialized | DNS Server has no data yet, is probably still synchronizing. |
Updating | DNS Server Controller version is being updated. |
Service Down | DNS server service is down and DNS server is not responding to queries. |
DNSServerSubtype
Defines possible DNS server subtypes.
Enumerations
Name | Description |
---|
Unknown | Unknown DNS server subtype. |
Win2003 | Microsoft Windows 2003 DNS server. |
Win2008 | Microsoft Windows 2008 DNS server. |
Win2012 | Microsoft Windows 2012 DNS server. |
BIND9 | ISC BIND DNS server. |
Unbound | The unbound version. |
DNSServerType
Defines possible DNS server types.
Enumerations
Name | Description |
---|
Unknown | Unknown DNS server type. |
MS | Microsoft DNS server. |
BIND | ISC BIND DNS server. |
Unbound | Unbound DNS caching server. |
Generic | Generic DNS server. |
DNSView
Contains all properties for a DNS view object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | Yes | The name of the DNS view. |
dnsServerRef | ObjRef | Yes | No | A reference to the server containing the view. |
ArrayOfDNSView
Elements
DNSZone
Contains all properties for a DNS zone object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the DNS zone. |
dynamic | boolean | No | No | Contains true if the zone is dynamic. |
adIntegrated | boolean | No | No | Contains true if the zone is Active Directory integrated. |
adReplicationType | ADReplicationType | No | No | The AD replication type if the zone is Active Directory integrated. |
adPartition | string | No | Yes | The AD partition if the zone is Active Directory integrated. |
dnsViewRef | ObjRef | No | No | Contains the reference ID of the DNS view that contains the zone. This property is not supplied for AD integrated zones. |
dnsViewRefs | ArrayOfObjRef | No | No | Contains the reference IDs of the DNS views that contain the zone. |
authority | string | No | No | Contains the name of the DNS server that contains the zone or the string "[Active Directory]" if the zone is AD integrated. |
type | DNSZoneType | Yes | No | Specifies the type of the zone. |
dnssecSigned | boolean | No | No | Contains true if the zone is a DNSSEC signed zone. |
kskIDs | string | No | Yes | A comma separated string of IDs of KSKs, starting with active keys, then inactive keys in parenthesis. |
zskIDs | string | No | Yes | A comma separated string of IDs of ZSKs, starting with active keys, then inactive keys in parenthesis. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the zone. |
ArrayOfDNSZone
Elements
DNSZoneType
Defines possible types for a DNS zone.
Enumerations
Name | Description |
---|
Master | Master zone. |
Slave | Slave zone. |
Hint | Hint zone. |
Stub | Stub zone. |
Forward | Forward zone. |
DateTime
Date/time.
Device
Contains all properties for a device object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the device. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the device. |
interfaces | ArrayOfInterface | No | Yes | The interfaces on the device. |
ArrayOfDevice
Elements
Discovery
Contains all properties for a ping discovery schedule that is used for ranges or scopes.
Elements
Name | Type | Required | Nillable | Description |
---|
interval | unsignedInt | Yes | No | The interval between runs for the discovery schedule. |
unit | TimeUnit | Yes | No | The time unit for the interval. |
Event
Contains all properties for an event object.
Elements
Name | Type | Required | Nillable | Description |
---|
eventType | EventType | Yes | No | Event type. |
objType | ObjectType | Yes | No | Object type. |
objRef | ObjRef | Yes | No | Reference to the object. |
objName | string | Yes | Yes | Name of the object. |
timestamp | DateTime | Yes | No | Timestamp of event. |
username | string | Yes | Yes | Name of the user associated with the event. |
saveComment | string | Yes | Yes | Save comment provided along with the event. |
eventText | string | Yes | Yes | Description of the event. |
ArrayOfEvent
Elements
EventType
Defines possible event types.
Enumerations
Name | Description |
---|
Unknown | Unknown event type. |
Creation | Object creation event. |
Modification | Object modification event. |
Deletion | Object deletion event. |
Refresh | Refresh event. |
Error | Error event. |
Reference | Reference event. |
Folder
Contains all properties for a folder object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the folder. |
contentType | ObjectType | Yes | No | The type of objects contained within the folder. |
parentRef | ObjRef | No | No | A reference to the parent folder. |
ArrayOfFolder
Elements
Group
Contains all properties for a user group object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the group. |
description | string | No | Yes | A description for the group. |
adIntegrated | boolean | No | No | Contains true if the group is Active Directory integrated. |
groupMembers | ArrayOfObject | No | Yes | An array of references to the users in the group. |
roles | ArrayOfObject | No | Yes | An array of references to the roles the group has. |
ArrayOfGroup
Elements
HasAccessEntry
An entry that contains information about whether the currently logged in user has access for a specific access entry for a specific object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the object for which this entry applies. |
objType | ObjectType | Yes | No | The type of the object for which this entry applies. |
name | string | Yes | No | The name of the object for which this entry applies. |
hasAccess | boolean | Yes | No | Contains true if the user has access for the access entry. |
ArrayOfHasAccessEntry
Elements
HexStr
Hexadecimal encoded string.
HostDiscoveryReportEntry
Contains information about host discovery.
Elements
Name | Type | Required | Nillable | Description |
---|
addrRef | ObjRef | Yes | No | Reference to the host IP address. |
address | string | Yes | No | The host IP address. |
dnsHostNames | string | Yes | Yes | Comma separated list of DNS host names found for the IP address. |
lastSeenDate | DateTime | Yes | No | The date when the host address last responded to a ping request. |
lastDiscoveryDate | DateTime | Yes | No | The date when the system last checked whether the host address responded to a ping request. |
lastKnownClientIdentifier | string | Yes | Yes | The MAC address associated with the IP address discovery info. |
discoveryType | IPAddressDiscoveryType | Yes | No | The type of IP address discovery that is the source of the IP address discovery info. |
customProperties | ArrayOfProperty | Yes | Yes | The custom properties associated with the host address. |
ArrayOfHostDiscoveryReportEntry
Elements
HostDiscoveryType
Defines possible host discovery report types.
Enumerations
Name | Description |
---|
HostsWithData | Report on hosts with data which have not been answering during discovery. |
HostsWithoutData | Report on hosts without data which have answered during discovery. |
IPAMRecord
Contains all properties for an IPAM record object.
Elements
Name | Type | Required | Nillable | Description |
---|
addrRef | ObjRef | Yes | No | A reference to the IP address. |
address | string | Yes | No | The IP address. |
claimed | boolean | Yes | No | Contains true if the record has the Claimed flag set. Obsolete, replaced by state. |
dnsHosts | ArrayOfDNSHost | Yes | Yes | List of DNS hosts associated with the address. |
dhcpReservations | ArrayOfDHCPReservation | Yes | Yes | List of DHCP reservations associated with the address. |
dhcpLeases | ArrayOfDHCPLease | Yes | Yes | List of DHCP leases associated with the address. |
discoveryType | IPAddressDiscoveryType | Yes | No | The type of IP address discovery that is the source of the IP address discovery info. |
lastSeenDate | string | Yes | Yes | The date when the address was last seen during IP address discovery. |
lastDiscoveryDate | string | Yes | Yes | The date when the system last performed IP address discovery for this IP address. |
lastKnownClientIdentifier | string | Yes | Yes | The MAC address associated with the IP address discovery info. |
device | string | No | Yes | The device associated with the record. |
interface | string | No | Yes | The interface associated with the record. |
ptrStatus | PTRStatus | No | No | The PTR record status for the record. |
extraneousPTR | boolean | No | No | Contains true if there are extraneous PTR records for the record. |
customProperties | ArrayOfProperty | Yes | Yes | The custom properties for the IPAM record. |
state | IPAMRecordState | No | No | Specifies the IP address state. |
usage | unsignedInt | No | No | IP address usage bitmask. |
ArrayOfIPAMRecord
Elements
IPAMRecordState
Defines possible IPAM record states.
Enumerations
Name | Description |
---|
Free | IP address is free. |
Assigned | IP address is assigned. |
Claimed | IP address is claimed. |
IPAddress
IPv4/IPv6 address.
ArrayOfIPAddress
Elements
IPAddressDiscoveryType
Defines possible IP address discovery types.
Enumerations
Name | Description |
---|
None | IP address has no discovery info. |
Ping | IP address answered ping during scheduled discovery. |
ARP | IP address was present in a router's ARP cache. |
Lease | IP address had a DHCP lease. |
Custom | IP address discovery info was supplied externally. |
IPOrHostname
IPv4/IPv6 address or legal host name.
IdentityAccess
Contains access entries for a specific user or group.
Elements
Name | Type | Required | Nillable | Description |
---|
identityRef | ObjRef | Yes | No | A unique reference ID for a user or group for which the access applies. |
identityName | string | No | No | The name of the user or group for which the access applies. |
accessEntries | ArrayOfAccessEntry | Yes | Yes | The access entries for the user or group. |
ArrayOfIdentityAccess
Elements
Interface
Contains all properties for an interface object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the interface. |
clientIdentifier | string | No | Yes | The client identifier for the interface. |
addresses | ArrayOfIPAddress | No | Yes | The addresses for the interface. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the interface. |
deviceRef | ObjRef | No | No | A unique reference ID of the device to which the interface belongs. |
ArrayOfInterface
Elements
MergeAddressSpacesReportConflictType
Defines possible merge address space conflict types returned by report.
Enumerations
Name | Description |
---|
Warning | Warning. |
Error | Error. |
MergeAddressSpacesReportEntry
Contains information about a merge address space conflict.
Elements
Name | Type | Required | Nillable | Description |
---|
conflictType | MergeAddressSpacesReportConflictType | Yes | No | Conflict type. |
srcObjRef | ObjRef | Yes | No | A reference to an object in the source address space. |
destObjRef | ObjRef | Yes | No | A reference to a conflicting object in the destination address space. |
description | string | Yes | No | Conflict description. |
ArrayOfMergeAddressSpacesReportEntry
Elements
MultiLabelHostReportEntry
Contains information about a host in the multi-label host report.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Ref of the DNS record. |
name | string | Yes | No | The name of the DNS record, partially qualified. |
zonename | string | Yes | No | The name of the zone. |
type | DNSRecordType | Yes | No | Specifies the type of the DNS record. |
data | string | Yes | No | Contains the record data in a tab-separated list. |
ArrayOfMultiLabelHostReportEntry
Elements
NetworkDiscoveryInfo
Contains Network Discovery Info
Elements
Name | Type | Required | Nillable | Description |
---|
routerName | string | No | No | The name of the router. |
gateway | IPAddress | No | No | The IP address of the gateway. |
interfaceID | unsignedInt | No | No | The interface ID. |
interfaceName | string | No | No | The interface name. |
VLANID | unsignedInt | No | No | The VLAN ID for the interface. |
interfaceDescription | string | No | Yes | The interface description. |
VRFName | string | No | Yes | The VRF name assigned to the interface. |
ArrayOfNetworkDiscoveryInfo
Elements
ObjRef
A reference to an object.
ArrayOfObjRef
Elements
Object
Contains information about a generic object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | A reference to the object. |
objType | ObjectType | No | No | The type of the object. |
name | string | No | No | The name of the object. |
ArrayOfObject
Elements
ObjectAccess
Contains information about an object access entry.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | A reference to the object. |
name | string | Yes | No | The name of the object. |
identityAccess | ArrayOfIdentityAccess | No | Yes | An array of access entries for different users and groups for the object. |
ArrayOfObjectAccess
Elements
ObjectError
Contains information about an error related to an operation on an object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | A reference to the object. |
error | string | Yes | No | The error string. |
ArrayOfObjectError
Elements
ObjectType
Defines possible object types.
Enumerations
Name | Description |
---|
Unknown | Unknown object type. |
Suite | The Men and Mice Suite. |
DNSServer | DNS server. |
DHCPServer | DHCP server. |
DNSZone | DNS zone. |
DNSView | DNS view. |
Range | IP Address range. |
DHCPScope | DHCP scope. |
IPAddress | IP address. |
DHCPReservation | DHCP reservation. |
DHCPAddressPool | DHCP address pool. |
DHCPGroup | DHCP group. |
ADSite | Active Directory site. |
DNSRecord | DNS resource record. |
User | User. |
Group | Group. |
DHCPExclusion | DHCP exclusion. |
DHCPFailoverPeer | DHCP failover peer. |
DHCPLease | DHCP lease. |
Device | Device. |
Interface | Interface for a device. |
Folder | Folder. |
ADSiteLink | Active Directory site link. |
AddressSpace | Address space. |
ADForest | Active Directory forest. |
ChangeRequest | Change request. |
Appliance | A Men & Mice Appliance. |
Role | Role. |
Cloud | Cloud. |
CloudNetwork | Cloud network. |
Superscope | Superscope. |
ArrayOfObjectType
Elements
PTRStatus
Defines possible status types for PTR records.
Enumerations
Name | Description |
---|
Unknown | Unknown status. |
OK | No errors found mapping the PTR record. |
Verify | Errors or inconsistencies found when mapping the PTR record. |
Property
Contains a single property entry for an object.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the property. |
value | string | No | Yes | The value of the property. |
ArrayOfProperty
Elements
PropertyDefinition
Contains the property definition for a property.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the property. |
type | PropertyType | Yes | No | The type of the property. |
system | boolean | No | No | Contains true if the property is system defined. |
mandatory | boolean | No | No | Determines if the property is mandatory. |
readOnly | boolean | No | No | Determines if the property is read-only. |
multiLine | boolean | No | No | Determines if the property is multi-line. |
defaultValue | string | No | Yes | Contains the default value for the property. |
listItems | ArrayOfString | No | Yes | Contains the list items if the property is an enumeration. |
parentProperty | string | No | No | Name of the parent property. |
ArrayOfPropertyDefinition
Elements
PropertyType
Defines the possible data types for a custom property.
Enumerations
Name | Description |
---|
String | Free form string. |
HexStr | Hexadecimal encoded string. |
Boolean | Boolean. |
IPAddress | IPv4/IPv6 address. |
IPOrHostname | IPv4/IPv6 address or a legal host name. |
Integer | Integer. |
Range
Contains all properties for a range object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the range. |
from | IPAddress | No | No | The starting IP address of the range. |
to | IPAddress | No | No | The ending IP address of the range. |
parentRef | ObjRef | No | No | A reference to the immediate parent range. |
adSiteRef | ObjRef | No | No | A reference to the AD site to which the range belongs. |
childRanges | ArrayOfObject | No | Yes | An array of child ranges of the range. |
dhcpScopes | ArrayOfObject | No | Yes | An array of scopes associated with the range. |
subnet | boolean | No | No | Determines if the range is defined as a subnet. |
locked | boolean | No | No | Determines if the range should be set as locked. |
autoAssign | boolean | No | No | Determines if it should be possible to automatically assign IP addresses from the range. |
hasSchedule | boolean | No | No | Determines if a discovery schedule has been set for the range. |
hasMonitor | boolean | No | No | Determines if monitoring is enabled for the range. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the range. |
inheritAccess | boolean | No | No | Should this range inherit its access bits from its parent range?. |
isContainer | boolean | No | No | Set to true to create a container instead of a range. |
utilizationPercentage | unsignedInt | No | No | Utilization percentage for range. |
hasRogueAddresses | boolean | No | No | If this range is a container, then this member will indicate whether there are rogue addresses in the container. |
cloudNetworkRef | ObjRef | No | No | A reference to the cloud network to which the range belongs. |
cloudAllocationPools | ArrayOfAddressBlock | No | Yes | Addresses in subnet which should be available for dynamic allocation in the cloud. |
discoveredProperties | ArrayOfNetworkDiscoveryInfo | No | Yes | Network Discovery Information |
creationTime | DateTime | No | Yes | The time when the Range was created. |
ArrayOfRange
Elements
RangeWithStatistics
Contains a range object along with statistics for that range.
Elements
Name | Type | Required | Nillable | Description |
---|
range | Range | Yes | No | The range object. |
used | string | Yes | No | Number of used IP addresses in the range. |
free | string | Yes | No | Number of free IP addresses in the range. |
utilization | int | Yes | No | Utilization percentage for the range. |
ArrayOfRangeWithStatistics
Elements
Role
Contains all properties for a role object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The name of the role. |
description | string | No | Yes | A description for the role. |
users | ArrayOfObject | No | Yes | An array of references to users that have the role. |
groups | ArrayOfObject | No | Yes | An array of references to groups that have the role. |
ArrayOfRole
Elements
ServiceStatus
The state of a service.
Enumerations
Name | Description |
---|
undefined | Status is undefined. |
running | The service is running. |
stopped | The service is stopped. |
exited | The service has exited. |
fatal | The service is dead. |
SortOrder
Defines sorting order for a list.
Enumerations
Name | Description |
---|
Ascending | Sort order ascending. |
Descending | Sort order descending. |
SourcedDHCPOptions
Contains DHCP options from a single source.
Elements
Name | Type | Required | Nillable | Description |
---|
source | Object | Yes | No | The source of the DHCP options. |
dhcpOptions | ArrayOfDHCPOption | Yes | Yes | The DHCP options. |
ArrayOfSourcedDHCPOptions
Elements
SubdomainHandling
How should we handle existing subdomains of subnets we're updating?
Enumerations
Name | Description |
---|
Ignore | Skip reverse records in subdomains. |
Update | Update reverse records in subdomains as well. |
SystemSetting
Contains a single system setting value.
Elements
Name | Type | Required | Nillable | Description |
---|
name | string | Yes | No | The name of the system setting. |
value | string | No | Yes | The value of the system setting. |
ArrayOfSystemSetting
Elements
TimeUnit
Defines possible time units.
Enumerations
Name | Description |
---|
Minutes | Minutes. |
Hours | Hours. |
Days | Days. |
Weeks | Weeks. |
Months | Months. |
TransportProtocol
Defines possible transports protocols.
Enumerations
Name | Description |
---|
UDP | UDP over an IPv4 connection. |
TCP | TCP over an IPv4 connection. |
UDP6 | UDP over an IPv6 connection. |
TCP6 | TCP over an IPv6 connection. |
User
Contains all properties for a user object.
Elements
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | No | No | A unique reference ID for the object. |
name | string | Yes | No | The login name of the user. |
password | string | No | Yes | The user password. |
fullName | string | No | Yes | The full name of the user. |
description | string | No | Yes | The description for the user. |
email | string | No | Yes | The users email address. |
authenticationType | AuthenticationType | Yes | No | The authentication type for the user. |
groups | ArrayOfObject | No | Yes | An array of the groups the user is a member of. |
roles | ArrayOfObject | No | Yes | An array of the roles the user has. |
ArrayOfUser
Elements
ZoneSet
An instance of the zones that were created.
Elements
Name | Type | Required | Nillable | Description |
---|
masterRef | ObjRef | Yes | No | A unique reference ID for the zone. |
slaveZoneRefs | ArrayOfObjRef | No | Yes | A list of unique reference IDs for the slave zones that were created. |
ZoneSets
Contains the zones that were created.
Elements
Name | Type | Required | Nillable | Description |
---|
zoneSet | ZoneSet | No | No | An instance of a zone that was created. |
Commands
AddADForest
Adds a new AD forest.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adForest | ADForest | Yes | No | The AD forest to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added AD forest. |
AddADSite
Adds a new AD site.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSite | ADSite | Yes | No | The AD site to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added AD site. |
AddADSiteLink
Adds a new AD site link.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSiteLink | ADSiteLink | Yes | No | The AD site link to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added AD site link. |
AddAddressSpace
Adds a new address space.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addressSpace | AddressSpace | Yes | No | The address space to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added address space. |
AddChangeRequest
Adds request for change(s).
Arguments
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added change request. |
AddCloud
Adds a new cloud.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
cloud | Cloud | Yes | No | The cloud to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added cloud. |
AddCloudNetwork
Adds a new cloud network.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
cloudNetwork | CloudNetwork | Yes | No | The cloud network to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added cloud network. |
AddDHCPAddressPool
Adds a new DHCP address pool.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpAddressPool | DHCPAddressPool | Yes | No | The DHCP address pool to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP address pool. |
AddDHCPExclusion
Adds a new DHCP exclusion.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpExclusion | DHCPExclusion | Yes | No | The DHCP exclusion to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP exclusion. |
AddDHCPFailoverRelationship
Adds a DHCP failover relationship.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpFailoverRelationship | DHCPFailoverRelationship | Yes | No | The DHCP failover relationship to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddDHCPGroup
Creates a DHCP group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpGroup | DHCPGroup | Yes | No | The DHCP group to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP Group. |
AddDHCPOptionDefinition
Adds a new DHCP option definition on the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | The DHCP server on which the option definition should be added. |
dhcpOptionDefinition | DHCPOptionDefinition | Yes | No | The DHCP option definition to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddDHCPPolicy
Adds a DHCP policy to the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope to which the DHCP policy should be added. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
dhcpPolicy | DHCPPolicy | Yes | No | The DHCP policy to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddDHCPReservation
Adds a new DHCP reservation.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpReservation | DHCPReservation | Yes | No | The DHCP reservation to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP reservation. |
AddDHCPScope
Adds a new DHCP scope.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScope | DHCPScope | Yes | No | The DHCP scope to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP scope. |
AddDHCPScopesToDHCPFailoverRelationship
Add DHCP scope(s) to a DHCP failover relationship.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
dhcpFailoverRelationshipName | string | Yes | No | The DHCP failover relationship. |
dhcpScopeRefs | ArrayOfObjRef | Yes | No | References to DHCP scopes that should be added to the DHCP failover relationship. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddDHCPServer
Adds a new DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServer | DHCPServer | Yes | No | The DHCP server to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DHCP server. |
warning | string | No | No | Warning message returned if the added DHCP server is e.g. of an old or unknown version. |
AddDNSGenerateDirective
Adds a new DNS generate directive.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | An object reference for the DNS zone. |
dnsGenerateDirective | DNSGenerateDirective | Yes | No | The DNS generate directive to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DNS generate directive. |
AddDNSRecord
Adds a new DNS record.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecord | DNSRecord | Yes | No | The DNS record to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
autoAssignRangeRef | ObjRef | No | No | A reference to a range that should be used for automatic assignment of IP addresses. |
forceOverrideOfNamingConflictCheck | boolean | No | No | Set to true to force creation of record regardless of naming conflict check (if enabled in system settings). |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DNS record. |
AddDNSRecordChangeRequest
Adds request for DNS record change(s).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordChanges | ArrayOfDNSRecordChange | Yes | No | The requested DNS record change(s). |
requestDate | DateTime | No | Yes | The date and time, when the requested DNS record change(s) should be applied, if specified. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the change request. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DNS record change request. |
AddDNSRecords
Adds multiple new DNS records.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecords | ArrayOfDNSRecord | Yes | No | The DNS records to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
autoAssignRangeRef | ObjRef | No | No | A reference to a range that should be used for automatic assignment of IP addresses. |
forceOverrideOfNamingConflictCheck | boolean | No | No | Set to true to force creation of record regardless of naming conflict check (if enabled in system settings). |
Response
Name | Type | Required | Nillable | Description |
---|
objRefs | ArrayOfObjRef | Yes | No | References to the added DNS records. If a record was not successfully added, the reference returned for that record will be {#0-#0}. |
errors | ArrayOfError | Yes | Yes | Error messages. One error message is generated for each record that is not added. |
AddDNSServer
Adds a new DNS server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServer | DNSServer | Yes | No | The DNS server to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DNS server. |
AddDNSZone
Adds a new DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZone | DNSZone | Yes | No | The DNS zone to add. |
masters | ArrayOfIPAddress | No | No | The IP addresses of the master servers if the new zone is not a master zone. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added DNS zone. |
AddDNSZones
Adds DNS Zones.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
names | ArrayOfString | Yes | No | List of zone names. |
adIntegrated | boolean | No | Yes | Contains true if the zone is Active Directory integrated. |
dynamic | boolean | No | Yes | Contains true if the zone is dynamic. |
adReplicationType | ADReplicationType | No | Yes | The AD replication type if the zone is Active Directory integrated. |
adPartition | string | No | Yes | The AD partition if the zone is Active Directory integrated. |
masterViewRef | ObjRef | Yes | No | Reference to the master server view. |
customProperties | ArrayOfProperty | No | Yes | The custom properties for the zone. |
slaveServerViewRefs | ArrayOfObjRef | No | Yes | Reference to the slave server views. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
zoneSets | ZoneSets | Yes | Yes | List of created zones. |
AddDevice
Adds a new device.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
device | Device | Yes | No | The device to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added device. |
AddFolder
Adds a new folder.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
folder | Folder | Yes | No | The folder to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added folder. |
AddGroup
Adds a new user group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
group | Group | Yes | No | The group to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added group. |
AddInterface
Adds a new interface.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
interface | Interface | Yes | No | The interface to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added interface. |
AddLicenseKey
Adds a new license key to the system.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
licenseKey | string | Yes | No | The license key to add. |
AddPropertyDefinition
Adds a new custom property definition.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objType | ObjectType | Yes | No | The object type for which the custom property definition should be added. |
propertyDefinition | PropertyDefinition | Yes | No | The custom property definition to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddRange
Adds a new address range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
range | Range | Yes | No | The address range to add. |
discovery | Discovery | No | No | The discovery (ping) schedule that should be set for the address range. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added address range. |
AddRole
Adds a new role.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
role | Role | Yes | No | The role to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added role. |
AddRoleToGroup
Adds a role to a group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
roleRef | ObjRef | Yes | No | A reference to the role to add. |
groupRef | ObjRef | Yes | No | A reference to the group to which the role should be added. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddRoleToUser
Adds a role to a user.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
roleRef | ObjRef | Yes | No | A reference to the role to which the user should be added. |
userRef | ObjRef | Yes | No | A reference to the user to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
AddUser
Adds a new user.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
user | User | Yes | No | The user to add. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the added user. |
AddUserToGroup
Adds a user to a group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
userRef | ObjRef | Yes | No | A reference to the user to add. |
groupRef | ObjRef | Yes | No | A reference to the group to which the user should be added. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ApproveChanges
Approve change(s).
Arguments
ApproveDNSRecordChanges
Approves DNS record change(s).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordChangeRequestRef | ObjRef | Yes | No | An object reference for the DNS record change request. |
dnsRecordChanges | ArrayOfDNSRecordChange | Yes | No | The requested DNS record change(s). |
saveComment | string | No | Yes | Save comment text to associate with the action. |
FlushFromCacheOnDNSServers
Flushes a single or all DNS entries from cache on given servers.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServerRefs | ArrayOfObjRef | Yes | No | An array of object references for the DNS servers. |
entry | string | No | Yes | Entry to be flushed from cache. If no entry is specified, then the entire cache is flushed. |
flushRecursively | boolean | No | Yes | Recursively flush the entire domain. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ForceSynchronization
Sends an synchronization request to the specified address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the object to request sync for. |
objType | ObjectType | No | No | The type of the object for which to set the DHCP options. |
Response
Name | Type | Required | Nillable | Description |
---|
syncTime | unsignedInt | Yes | No | The synchronization time in milliseconds. -1 if failure. |
GenerateReverseRecords
Generates or updates reverse records.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
subnets | ArrayOfString | Yes | No | Subnets or reverse zones for which reverse records should be generated/updated. |
viewName | string | No | Yes | View for which reverse records should be generated/updated. |
subdomainHandling | SubdomainHandling | Yes | No | How should we handle existing subdomains of subnets we're updating? |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfString | No | Yes | Non-fatal errors that occurred during the update process. |
GetADForest
Gets specified AD forest.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adForestRef | ObjRef | Yes | No | The object reference for the AD Forest. |
Response
Name | Type | Required | Nillable | Description |
---|
adForest | ADForest | Yes | No | The AD Forest object. |
GetADForests
Gets AD forests.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
adForests | ArrayOfADForest | Yes | Yes | List of AD Forests. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetADPartitions
Gets AD partitions from the specified DNS server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServerRef | ObjRef | Yes | No | A reference to the DNS server from which to retrieve the Active Directory partitions. |
Response
Name | Type | Required | Nillable | Description |
---|
adPartitions | ArrayOfString | Yes | Yes | List of Active Directory partitions. |
GetADSite
Gets specified AD site.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSiteRef | ObjRef | Yes | No | The object reference for the AD Site. |
Response
Name | Type | Required | Nillable | Description |
---|
adSite | ADSite | Yes | No | The AD Site object. |
GetADSiteLink
Gets specified AD site link.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSiteLinkRef | ObjRef | Yes | No | The object reference for the AD Site Link. |
Response
Name | Type | Required | Nillable | Description |
---|
adSiteLink | ADSiteLink | Yes | No | The AD Site Link object. |
GetADSiteLinks
Gets AD site links.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
adSiteLinks | ArrayOfADSiteLink | Yes | Yes | List of AD Site Links. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetADSites
Gets AD sites.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
adSites | ArrayOfADSite | Yes | Yes | List of AD Sites. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetAddressBlocks
Gets specified address range's address blocks.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | Reference to the address range. |
Response
Name | Type | Required | Nillable | Description |
---|
addressBlocks | ArrayOfAddressBlock | Yes | Yes | Address range's address blocks. |
GetAddressSpace
Gets specified address space.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addressSpaceRef | ObjRef | Yes | No | The object reference for the address space. |
Response
Name | Type | Required | Nillable | Description |
---|
addressSpace | AddressSpace | Yes | No | The address space object. |
GetAddressSpaces
Gets address spaces.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
addressSpaces | ArrayOfAddressSpace | Yes | Yes | List of address spaces. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetAddressesInUse
Gets addresses in use within the specified address range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
lastseen | Discovery | No | No | Used to filter by the time each address was last seen during discovery (ping). |
ranges | ArrayOfRangeTitle | Yes | No | Names of the address ranges in which to look for addresses. |
Response
Name | Type | Required | Nillable | Description |
---|
addresses | ArrayOfAddress | Yes | Yes | Addresses that are considered to be in use in the specified address ranges. |
GetAvailableAddressBlocks
Gets available address blocks within the specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | An object reference for the range. |
limit | unsignedInt | No | No | The number of address blocks to return. |
mask | unsignedInt | No | No | The minimum size of the address blocks, specified as a subnet mask. |
size | unsignedInt | No | No | The minimum size of the address blocks, specified as the number of addresses. |
ignoreSubnetFlag | boolean | No | No | Determines whether the subnet flag should be ignored when determining the size of the address blocks. |
startAddress | IPAddress | No | No | The starting address to use when looking for the next available address block. Ignored when mask is not provided. |
Response
Name | Type | Required | Nillable | Description |
---|
addressBlocks | ArrayOfAddressBlock | Yes | Yes | Array of address blocks fulfilling the given criteria. |
GetChangeRequest
Gets specified change request.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
changeRequestRef | ObjRef | Yes | No | An object reference for the change request. |
Response
Name | Type | Required | Nillable | Description |
---|
changeRequest | ChangeRequest | Yes | No | The change request object. |
GetChangeRequests
Gets change requests.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
includeChanges | boolean | No | No | Specifies whether changes should be included in the result. |
includeProcessedRequests | boolean | No | No | Specifies whether change requests that have already been processed should be included in the result. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
changeRequests | ArrayOfChangeRequest | Yes | Yes | List of change requests. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetCloud
Gets a cloud object based on the object reference.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
cloudRef | ObjRef | Yes | No | An object reference for the cloud. |
Response
Name | Type | Required | Nillable | Description |
---|
cloud | Cloud | Yes | No | The cloud object. |
GetCloudNetwork
Gets a cloud network object based on the object reference.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
cloudNetworkRef | ObjRef | Yes | No | An object reference for the cloud network. |
Response
Name | Type | Required | Nillable | Description |
---|
cloudNetwork | CloudNetwork | Yes | No | The cloud network object. |
GetCloudNetworks
Gets a list of cloud networks.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
cloudNetworks | ArrayOfCloudNetwork | Yes | Yes | List of cloud networks. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetClouds
Gets a list of clouds.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
clouds | ArrayOfCloud | Yes | Yes | List of clouds. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetCurrentAddressSpace
Gets address space that the user is currently in.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
Response
Name | Type | Required | Nillable | Description |
---|
addressSpaceRef | ObjRef | Yes | No | A reference to the current address space. |
GetCustomFilters
Gets a list of custom filters.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
Response
Name | Type | Required | Nillable | Description |
---|
filters | ArrayOfCustomFilter | Yes | Yes | List of filters. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPAddressPool
Gets specified DHCP address pool.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpAddressPoolRef | ObjRef | Yes | No | An object reference for the DHCP address pool. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpAddressPool | DHCPAddressPool | Yes | No | The DHCP address pool object. |
GetDHCPAddressPoolPermitList
Gets DHCP address pool permit list for the specified DHCP address pool.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpAddressPoolRef | ObjRef | Yes | No | An object reference for the DHCP address pool from which to get the address pool permit list. |
Response
GetDHCPAddressPools
Gets DHCP address spools.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScopeRef | ObjRef | No | No | A reference to the scope containing the address pool(s). |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpAddressPools | ArrayOfDHCPAddressPool | Yes | Yes | List of DHCP address pools. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPBackupStatus
Gets backup status for the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpBackupExists | boolean | Yes | No | Determines whether a backup exists for the DHCP server. |
dhcpBackupTimestamp | DateTime | Yes | No | Contains the timestamp for the latest backup. |
GetDHCPClassNames
Gets DHCP class names from the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpClassNames | ArrayOfString | Yes | Yes | An array of DHCP class names. |
GetDHCPConcurrentLeases
Gets concurrent leases.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpConcurrentLeases | ArrayOfDHCPConcurrentLease | Yes | Yes | An array of leases active in more than one location. |
GetDHCPExclusion
Gets specified DHCP exclusion.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpExclusionRef | ObjRef | Yes | No | An object reference for the DHCP exclusion. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpExclusion | DHCPExclusion | Yes | No | The DHCP exclusion object. |
GetDHCPExclusions
Gets DHCP exclusions.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScopeRef | ObjRef | No | No | A reference to the scope containing the exclusion(s). |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpExclusions | ArrayOfDHCPExclusion | Yes | Yes | List of DHCP exclusions. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPFailoverRelationship
Get a DHCP failover relationship.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
dhcpFailoverRelationshipName | string | Yes | No | The DHCP failover relationship to retrieve. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpFailoverRelationship | DHCPFailoverRelationship | Yes | No | The DHCP failover relationship retrieved. |
GetDHCPFailoverRelationships
Get all DHCP failover relationships from specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
Response
GetDHCPGroup
Gets specified DHCP group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpGroupRef | ObjRef | Yes | No | An object reference for the DHCP group. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpGroup | DHCPGroup | Yes | No | The DHCP group object. |
GetDHCPGroups
Gets DHCP groups from the specified owner (which must reference either a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the object containing the DHCP group(s). |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpGroups | ArrayOfDHCPGroup | Yes | Yes | List of DHCP groups. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPLeaseHistory
Gets DHCP lease history matching the specified field and filter.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
field | DHCPLeaseField | Yes | No | The field by which to filter. |
filter | string | Yes | No | Filtering criteria for the records returned. |
exactMatch | boolean | No | No | Set to true if the field should match the filter exactly. |
collapseRenew | boolean | No | No | Set to true if renew entries should be collapsed into a single lease history entry. |
startDate | DateTime | No | Yes | Date of the first entry to retrieve. |
endDate | DateTime | No | Yes | Date of the last entry to retrieve. |
limit | unsignedInt | No | No | The number of records to return. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpLeaseHistoryEntries | ArrayOfDHCPLeaseHistoryEntry | Yes | Yes | Array of lease history entries fulfilling the search criteria. |
GetDHCPLeases
Gets DHCP leases from the specified DHCP scope.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScopeRef | ObjRef | Yes | No | A reference to the scope containing the leases. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpLeases | ArrayOfDHCPLease | Yes | Yes | List of DHCP leases. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPOptionDefinitions
Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | A reference to the object from which to get the DHCP option definitions. |
objType | ObjectType | No | No | The type of the object from which to get the DHCP option definitions. |
Response
GetDHCPOptions
Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | A reference to the object from which to get the DHCP options. |
objType | ObjectType | No | No | The type of the object from which to get the DHCP options. |
Response
Name | Type | Required | Nillable | Description |
---|
ticket | unsignedInt | Yes | No | Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail. |
dhcpOptions | ArrayOfDHCPOption | Yes | Yes | The DHCP options. |
GetDHCPPolicies
Get all DHCP policies from the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope containing the DHCP policies. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpPolicies | ArrayOfDHCPPolicy | Yes | Yes | The DHCP policies retrieved. |
GetDHCPPolicyEnforcement
Gets DHCP policy enforcement as set for the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope for which the DHCP policy enforcement is set. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
Response
Name | Type | Required | Nillable | Description |
---|
enforcing | boolean | Yes | No | Specifies whether DHCP policies are being enforced. |
GetDHCPReservation
Gets specified DHCP reservation.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpReservationRef | ObjRef | Yes | No | An object reference for the DHCP reservation. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpReservation | DHCPReservation | Yes | No | The DHCP reservation object. |
GetDHCPReservations
Gets DHCP reservations from the specified owner (which must reference a DHCP server, a DHCP group, or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/group/scope containing the reservations. |
objType | ObjectType | No | No | The object type of the owner (i.e. one of DHCP server/group/scope) |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpReservations | ArrayOfDHCPReservation | Yes | Yes | List of DHCP reservations. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPScope
Gets specified DHCP scope.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScopeRef | ObjRef | Yes | No | An object reference for the DHCP scope. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpScope | DHCPScope | Yes | No | The DHCP scope object. |
GetDHCPScopes
Gets DHCP scopes.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpScopes | ArrayOfDHCPScope | Yes | Yes | List of DHCP scopes. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPServer
Gets specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpServer | DHCPServer | Yes | No | The DHCP server object. |
GetDHCPServers
Gets DHCP servers.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpServers | ArrayOfDHCPServer | Yes | Yes | List of DHCP servers. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDHCPSubclasses
Gets DHCP subclasses from the specified DHCP class on the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
dhcpClassName | string | Yes | No | The name of the DHCP class for which to retrieve the subclasses. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpSubclasses | ArrayOfString | Yes | Yes | An array of DHCP subclasses. |
GetDHCPVendorAndUserClasses
Gets DHCP vendor and user classes from the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
Response
GetDNSGenerateDirective
Gets specified DNS generate directive.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsGenerateDirectiveRef | ObjRef | Yes | No | An object reference for the DNS generate directive. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsGenerateDirective | DNSGenerateDirective | Yes | No | The DNS generate directive object. |
GetDNSGenerateDirectives
Gets DNS generate directives from the specified DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | Reference to the zone containing the generate directives. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsGenerateDirectives | ArrayOfDNSGenerateDirective | Yes | Yes | List of DNS generate directives. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSPTRRecords
Gets all reverse PTR records for specified IP address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
address | IPAddress | Yes | No | The IP address. |
dnsZoneRef | ObjRef | Yes | No | Reference to a forward zone. |
Response
Name | Type | Required | Nillable | Description |
---|
reverseRecords | ArrayOfDNSRecord | Yes | Yes | List of reverse records for the specified IP address. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSRecord
Gets specified DNS record.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordRef | ObjRef | Yes | No | An object reference for the DNS record. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecord | DNSRecord | Yes | No | The DNS record object. |
GetDNSRecordChangeRequest
Gets specified DNS record change request.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordChangeRequestRef | ObjRef | Yes | No | An object reference for the DNS record change request. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecordChangeRequest | DNSRecordChangeRequest | Yes | No | The DNS record change request object. |
GetDNSRecordChangeRequests
Gets DNS record change requests.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
includeDNSRecordChanges | boolean | No | No | Specifies whether DNS record changes should be included in the result. |
includeProcessedRequests | boolean | No | No | Specifies whether DNS record change requests that have already been processed should be included in the result. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecordChangeRequests | ArrayOfDNSRecordChangeRequest | Yes | Yes | List of DNS record change requests. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSRecords
Gets DNS records from the specified DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | Reference to the zone containing the records. |
filter | string | No | Yes | Filtering criteria for the records returned. |
hideNonAccessibleHosts | boolean | No | No | If set to true the resulting set will not contain records for which the user has no access. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecords | ArrayOfDNSRecord | Yes | Yes | List of records. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSRecordsInCaches
Get DNS records with a certain pattern that are cached on given DNS servers.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServerRefs | ArrayOfObjRef | No | Yes | List of DNS servers to search on. |
dnsSearchPattern | string | Yes | No | The pattern to search for. Should be a fully qualified domain name. |
limit | unsignedInt | No | No | The number of records to return. A limit of zero returns all matched records. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsCaches | ArrayOfDNSCache | Yes | Yes | List of DNS caches. |
errors | ArrayOfObjectError | Yes | Yes | List of error messages. One for each server that could not be queried due to an error. |
GetDNSReverseZone
Gets reverse DNS zone for specified IP address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
address | IPAddress | Yes | No | The IP address. |
dnsZoneRef | ObjRef | Yes | No | Reference to a forward zone. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsZone | DNSZone | No | Yes | The reverse DNS zone for the specified IP address. |
GetDNSServer
Gets specified DNS server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServerRef | ObjRef | Yes | No | An object reference for the DNS server. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsServer | DNSServer | Yes | No | The DNS server object. |
GetDNSServers
Gets DNS servers.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsServers | ArrayOfDNSServer | Yes | Yes | List of DNS servers. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSView
Gets specified DNS view.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsViewRef | ObjRef | Yes | No | An object reference for the DNS view. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsView | DNSView | Yes | No | The DNS view object. |
GetDNSViews
Gets DNS views.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsServerRef | ObjRef | No | No | A reference to the DNS server |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsViews | ArrayOfDNSView | Yes | Yes | List of DNS server views. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDNSZone
Gets specified DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | An object reference for the DNS zone. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsZone | DNSZone | Yes | No | The DNS zone object. |
GetDNSZones
Gets DNS zones.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsZones | ArrayOfDNSZone | Yes | Yes | List of zones. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetDevice
Gets specified device.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
deviceRef | ObjRef | Yes | No | The object reference for the device |
Response
Name | Type | Required | Nillable | Description |
---|
device | Device | Yes | No | The device object. |
GetDevices
Gets devices.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
devices | ArrayOfDevice | Yes | Yes | List of devices. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetFolder
Gets specified folder.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
folderRef | ObjRef | Yes | No | An object reference for the folder. |
Response
Name | Type | Required | Nillable | Description |
---|
folder | Folder | Yes | No | The folder object. |
GetFolderForObject
Gets the folder that contains the specified object.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | A reference to the object for which to retrieve the containing folder. |
objType | ObjectType | No | No | The object type. |
Response
Name | Type | Required | Nillable | Description |
---|
folder | ObjRef | No | No | The folder object. |
GetFolders
Gets a list of folders.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
folders | ArrayOfFolder | Yes | Yes | List of folders. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetGroup
Gets a group object based on the object reference.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
groupRef | ObjRef | Yes | No | An object reference for the group. |
Response
Name | Type | Required | Nillable | Description |
---|
group | Group | Yes | No | The group object. |
GetGroups
Gets a list of user groups.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
groups | ArrayOfGroup | Yes | Yes | List of groups. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetHistory
Gets event history.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
eventType | EventType | No | No | The type of event to retrieve. If not specified, entries for all event types are retrieved. |
objType | ObjectType | No | No | The type of object to retrieve. If not specified, entries for all object types are retrieved. |
objRef | ObjRef | No | No | If specified, only history entries for the specified object will be retrieved. |
username | string | No | Yes | The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved. |
startDate | DateTime | No | Yes | Date of the first entry to retrieve. |
endDate | DateTime | No | Yes | Date of the last entry to retrieve. |
filter | string | No | Yes | Filtering criteria for the records returned. |
limit | unsignedInt | No | No | The number of records to return. |
Response
Name | Type | Required | Nillable | Description |
---|
events | ArrayOfEvent | Yes | Yes | List of events. |
GetIPAMRecord
Gets IPAM record for the specified IP address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addrRef | ObjRef | Yes | No | An object reference for the IPAM record. |
requireRangeRef | ObjRef | No | No | Reference to a range in which the relevant IP address must reside, otherwise the GetIPAMRecord call will fail. |
excludeDHCP | boolean | No | No | Set to true to exclude DHCP data from result. |
Response
Name | Type | Required | Nillable | Description |
---|
ipamRecord | IPAMRecord | Yes | No | The IPAM record object. |
GetIPAMRecords
Gets IPAM records from a specific range or for specific IPAM records.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | No | No | A reference to the range containing the addresses. Specified when getting IPAM records from a specific range. |
addrRefs | ArrayOfObjRef | No | No | An array of references to the IPAM records to retrieve. Specified when getting specific IPAM records. |
includeRelatedDNSRecords | boolean | No | No | Set to true if IPAM record should include DNS records related to any DNS hosts returned. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
excludeDHCP | boolean | No | No | Set to true to exclude DHCP data from result. |
Response
Name | Type | Required | Nillable | Description |
---|
ipamRecords | ArrayOfIPAMRecord | Yes | Yes | List of IPAM records. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetInheritAccess
Gets inherit access flag for the specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | A reference to the range. |
Response
Name | Type | Required | Nillable | Description |
---|
inheritAccess | boolean | Yes | No | Inherit access flag. |
GetInheritedDHCPOptions
Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | A reference to the object for which to get inherited DHCP options. |
objType | ObjectType | No | No | The type of the object for which to get inherited DHCP options. |
Response
GetInterface
Gets specified interface.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
interfaceRef | ObjRef | Yes | No | The object reference for the interface. |
Response
Name | Type | Required | Nillable | Description |
---|
interface | Interface | Yes | No | The interface object. |
GetInterfaces
Gets interfaces.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
deviceRef | ObjRef | No | No | A reference to the device containing the interfaces. |
filter | string | No | Yes | Filtering criteria for the records returned |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
interfaces | ArrayOfInterface | Yes | Yes | List of interfaces. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetKeyStorageProviders
Gets specified DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | An object reference for the DNS zone. |
Response
Name | Type | Required | Nillable | Description |
---|
keyStorageProviders | ArrayOfString | Yes | No | Contains a list of storage providers installed on the DNS server. |
GetNextFreeAddress
Gets next free address from the specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | A reference to the address range from which to return the free address. |
startAddress | IPAddress | No | No | The starting address to use when looking for the next free address. |
ping | boolean | No | No | If true the system will ping the address found before returning. If the address responds to a ping request, it is considered to be in use. |
excludeDHCP | boolean | No | No | Set to true to exclude DHCP data from result. |
temporaryClaimTime | unsignedInt | No | No | If set, claims the next free address for the given time in seconds. |
Response
Name | Type | Required | Nillable | Description |
---|
address | IPAddress | No | No | The next free IP address in the address range. |
GetNextFreeReservationAddress
Gets next free reservable address from the specified scope.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objRef | ObjRef | Yes | No | A reference to the scope from which to return the free address. |
startAddress | IPAddress | No | No | The starting address to use when looking for the next free address. |
considerExclusionRange | boolean | No | No | Determines whether to look for a free address in an excluded range inside the scope. |
Response
Name | Type | Required | Nillable | Description |
---|
address | IPAddress | No | No | The next reservable IP address in the scope. |
GetObjectAccess
Gets access set for the specified object.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | A reference to the object. |
objType | ObjectType | No | No | The type of the object. |
identityRef | ObjRef | No | No | Object reference for a user or group. If specified, the command only retrieves access for the specified user or group. |
excludeBuiltinIdentities | boolean | No | No | Set to true to exclude access for builtin users and groups. |
Response
Name | Type | Required | Nillable | Description |
---|
objectAccess | ObjectAccess | Yes | No | Object access information. |
GetObjects
Gets specified objects.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objRefs | ArrayOfObjRef | Yes | No | Array of object references. |
objType | ObjectType | No | No | The type of the object. |
Response
Name | Type | Required | Nillable | Description |
---|
objects | ArrayOfObject | Yes | Yes | List of objects. |
GetOrphanReverseDNSRecords
Gets orphan reverse DNS records (i.e. PTR records whose corresponding A/AAAA record is missing).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
limit | unsignedInt | No | No | The number of records to return. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecords | ArrayOfDNSRecord | Yes | Yes | An array of PTR records having no corresponding A/AAAA record. |
totalResults | unsignedInt | No | No | Total number of records in the result set. |
GetProperties
Gets properties for the specified object.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the object for which to get the properties. |
objType | ObjectType | No | No | The type of the object. |
onlyCustom | boolean | No | No | Set to true if only the custom properties for the object should be returned. Default value is false. |
Response
Name | Type | Required | Nillable | Description |
---|
properties | ArrayOfProperty | Yes | Yes | List of properties for the object. |
GetPropertyDefinitions
Gets property definitions for the specified object type.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objType | ObjectType | Yes | No | The type of the object. |
Response
Name | Type | Required | Nillable | Description |
---|
propertyDefinitions | ArrayOfPropertyDefinition | Yes | Yes | List of property definitions for the object. |
GetRange
Gets specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | An object reference for the IPAM range. |
Response
Name | Type | Required | Nillable | Description |
---|
range | Range | Yes | No | The range object. |
GetRangeByIPAddress
Gets range containing specified IP address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addrRef | ObjRef | Yes | No | A reference to the IP address. |
Response
Name | Type | Required | Nillable | Description |
---|
range | Range | Yes | No | The range containing the specified IP address. |
GetRangeStatistics
Gets range statistics.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | A reference to the range. |
Response
Name | Type | Required | Nillable | Description |
---|
used | string | No | No | Number of used addresses in the address range. |
free | string | No | No | Number of free addresses in the address range. |
numInSubranges | string | No | No | Number of addresses in range allocated to subranges. |
percentInSubranges | string | Yes | No | Percent of range allocated to subranges. |
GetRanges
Gets ranges.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
folderRef | ObjRef | No | No | Reference to a folder from which to get ranges. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
ranges | ArrayOfRange | Yes | Yes | List of ranges. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetRangesWithStatistics
Gets ranges, along with their statistics.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
calculateUtilization | boolean | Yes | No | Determines whether to calculate the number of used and free addresses in the ranges. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
rangesWithStatistics | ArrayOfRangeWithStatistics | Yes | Yes | List of ranges with information about used and free addresses. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
Gets DNS records related to the specified DNS record (which must be either an A or AAAA record).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordRef | ObjRef | Yes | No | An object reference for the DNS address record for which to find associated records. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecords | ArrayOfDNSRecord | Yes | Yes | An array of records associated with the address record. |
GetRole
Gets a role object based on the object reference.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
roleRef | ObjRef | Yes | No | An object reference for the role. |
Response
Name | Type | Required | Nillable | Description |
---|
role | Role | Yes | No | The role object. |
GetRoles
Gets a list of roles.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
roles | ArrayOfRole | Yes | Yes | List of roles. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
GetRoutersForRange
Gets routers for the specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | A reference to the range. |
includeChildRanges | boolean | No | No | If set, return routers for child ranges as well |
Response
Name | Type | Required | Nillable | Description |
---|
addresses | ArrayOfIPAddress | Yes | Yes | List of router IP addresses. |
GetServiceStatus
.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
serverRef | ObjRef | Yes | No | An object reference for the DNS server. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
serviceStatus | ServiceStatus | Yes | No | The service status. |
GetSubranges
Gets subranges of the specified range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
parentRef | ObjRef | Yes | No | A reference to the range that contains the subranges. |
depth | unsignedInt | No | No | Specifies how many levels of subranges should be retrieved. |
Response
Name | Type | Required | Nillable | Description |
---|
ranges | ArrayOfRange | Yes | Yes | List of subranges. |
GetSystemSettings
Gets system settings.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
Response
GetUser
Gets specified user.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
userRef | ObjRef | Yes | No | An object reference for the user. Use "." to get the current user. |
Response
Name | Type | Required | Nillable | Description |
---|
user | User | Yes | No | The user object. |
GetUsers
Gets users.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
filter | string | No | Yes | Filtering criteria for the records returned. |
offset | unsignedInt | No | No | Specifies the offset to use when listing the records. A value of 0 starts with the first record. |
limit | unsignedInt | No | No | The number of records to return. |
sortBy | string | No | No | The name of the field to sort by. |
sortOrder | SortOrder | No | No | The sort order to use. |
Response
Name | Type | Required | Nillable | Description |
---|
users | ArrayOfUser | Yes | Yes | Array of users. |
totalResults | unsignedInt | Yes | No | Total number of records in the result set. |
HasAccess
Checks whether the currently logged in user has the specified access for the specified objects.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
accessName | string | Yes | No | The name of the access entry for which to check. |
objRefs | ArrayOfObjRef | Yes | No | References to the objects for which to check the access. |
objType | ObjectType | No | No | The type of the objects for which to check for access. |
Response
Name | Type | Required | Nillable | Description |
---|
hasAccessEntries | ArrayOfHasAccessEntry | Yes | No | Entries specifying whether the user has access to each object. |
JoinRanges
Joins the specified address ranges together into a new address range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ranges | ArrayOfObjRef | Yes | No | References to the address ranges to join. |
copyAccessFromRef | ObjRef | No | No | A reference to the address range containing the access information that should be used for the new address range. |
subnet | boolean | No | No | Determines if the new address range should be defined as a subnet. |
locked | boolean | No | No | Determines if the new address range should be set as locked. |
autoAssign | boolean | No | No | Determines if it should be possible to automatically assign IP addresses from the new address range. |
inheritAccess | boolean | No | No | Determines if the new address range should inherit access from its parent range. |
customProperties | ArrayOfProperty | No | No | The custom properties for the new address range. |
discovery | Discovery | No | No | The discovery (ping) schedule that should be set for the new address range. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ref | ObjRef | Yes | No | Reference to the resulting address range. |
Login
Logs into the Men & Mice Suite through the SOAP interface.
Arguments
Name | Type | Required | Nillable | Description |
---|
server | string | Yes | No | DNS name or IP address of the server running Men & Mice Central. |
loginName | string | Yes | No | Login name of user. |
password | string | Yes | No | User password. |
replaceControlCharacters | boolean | No | No | Determines if invalid control characters in user data should be replaced by a question mark. |
Response
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID for this login. |
Logout
Logs out of the Men & Mice Suite.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
MigrateDNSZone
Migrates a DNS zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | An object reference for the DNS zone. |
dnsServerRef | ObjRef | Yes | No | An object reference for the destination DNS server. |
dnsViewRef | ObjRef | No | Yes | An object reference for a view on the destination DNS server. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ModifyDHCPFailoverRelationship
Modifies the specified DHCP failover relationship on the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpFailoverRelationship | DHCPFailoverRelationship | Yes | No | The DHCP failover relationship to modify. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ModifyDHCPOptionDefinition
Modifies the specified DHCP option definition on the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | The DHCP server on which the option definition should be modified. |
dhcpOptionDefinition | DHCPOptionDefinition | Yes | No | The DHCP option definition to modify. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ModifyDHCPPolicy
Modifies the specified DHCP policy on the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope containing the DHCP policies. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
dhcpPolicyName | string | Yes | No | The DHCP policy to modify. |
dhcpPolicy | DHCPPolicy | Yes | No | The DHCP policy. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ModifyPropertyDefinition
Modifies a custom property definition.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objType | ObjectType | Yes | No | The object type to which the custom property definition is associated. |
property | string | Yes | No | The name of the custom property definition. |
propertyDefinition | PropertyDefinition | Yes | No | The modified custom property definition. |
updateExisting | boolean | No | No | Should objects be updated with the new value |
saveComment | string | No | Yes | Save comment text to associate with the action. |
MoveIPAMRecord
Moves an IPAM record from one IP address to another.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
fromRef | ObjRef | Yes | No | Reference to the IP address from which the IPAM record should be moved. |
toRef | ObjRef | Yes | No | Reference to the IP address to which the IPAM record should be moved. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
force | boolean | No | Yes | If set to true, will ignore and overwrite existing custom property values on destination IP address. |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfError | Yes | Yes | Error messages. One error message is generated for each part of the IPAM record that could not be successfully moved. |
MoveToAddressSpace
Moves the specified objects to the specified address space.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objRefs | ArrayOfObjRef | Yes | No | References to the objects that should be moved. |
objType | ObjectType | No | No | The type of the objects that should be moved. |
addressSpaceRef | ObjRef | No | No | Reference to the address space to which the objects should be moved. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
force | boolean | No | No | A flag to decide if the move should proceed or not when there are warnings on conflicting ranges or addresses in the target address space. |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfObjectError | Yes | Yes | Error messages. One error message is generated for each object that could not be successfully moved. |
Ping
Sends an ICMP ping request to the specified address.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addrRef | ObjRef | Yes | No | Reference to the IP address to ping. |
Response
Name | Type | Required | Nillable | Description |
---|
alive | boolean | Yes | No | Determines whether the host responded to the ping request. |
pingTime | unsignedInt | Yes | No | The response time in milliseconds. |
PlaceInADSite
Places the specified address ranges in the specified AD site.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSiteRef | ObjRef | Yes | No | Reference to the AD site in which the address ranges should be placed. |
rangeRefs | ArrayOfObjRef | Yes | No | References to the address ranges that should be placed in the AD site. |
location | string | No | Yes | Location property to be set for AD subnet. |
description | string | No | Yes | Description property to be set for AD subnet. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
PlaceInCloudNetwork
Places the specified subnets in the specified cloud network.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
cloudNetworkRef | ObjRef | Yes | No | Reference to the cloud network in which the subnets should be placed. |
cloudSubnets | ArrayOfCloudSubnet | Yes | No | The subnets that should be placed in the cloud network. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
PlaceInFolder
Places the specified objects in the specified folder.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
folderRef | ObjRef | Yes | No | Reference to the folder in which the objects should be placed. |
objRefs | ArrayOfObjRef | Yes | No | References to the objects that should be placed in the folder. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Promotes a DNS slave zone.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsZoneRef | ObjRef | Yes | No | An object reference for the DNS slave zone. |
unchangedPrimaryMaster | boolean | No | No | Specifies whether primary master field should be left unchanged. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ReconcileDHCPScope
Performs reconcile action on a specific scope or on all scopes on a specific server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the DHCP scope on which to perform the reconcile action or reference to the DHCP server on which to perform the reconcile action for each of the server's scopes. |
objType | ObjectType | No | No | The type of the object on which the reconcile action should be performed. Must be either DHCPServer or DHCPScope. |
fix | boolean | No | No | Set to true in order to instruct the relevant DHCP server to try and fix any entries that require reconciling. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
RejectChanges
Reject change(s).
Arguments
RejectDNSRecordChanges
Rejects DNS record change(s).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordChangeRequestRef | ObjRef | Yes | No | An object reference for the DNS record change request. |
dnsRecordChanges | ArrayOfDNSRecordChange | Yes | No | The requested DNS record change(s). |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ReleaseDHCPLease
Releases the specified DHCP lease.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpScopeRef | ObjRef | Yes | No | Reference to the DHCP scope from which the lease should be released. |
lease | IPAddress | Yes | No | IP address of the lease. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ReleaseDHCPLeases
Releases the specified DHCP leases.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpLeaseRef | ArrayOfDHCPLeaseReference | Yes | No | The DHCP leases to be released. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveDHCPFailoverRelationships
Remove a DHCP failover relationship.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
DHCPRefAndFailoverRelationshipNames | ArrayOfDHCPRefAndFailoverRelationshipNames | Yes | No | An array of DHCP failover relationships to remove. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveDHCPOptionDefinition
Removes the specified DHCP option definition from the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | The DHCP server from which the option definition should be removed. |
dhcpOptionDefinition | DHCPOptionDefinition | Yes | No | The DHCP option definition to remove. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveDHCPPolicy
Remove a DHCP policy from the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope containing the DHCP policy. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
dhcpPolicyName | string | Yes | No | The DHCP policy to remove. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveDHCPScopesFromDHCPFailoverRelationship
Remove DHCP scope(s) from a DHCP failover relationship.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
dhcpFailoverRelationshipName | string | Yes | No | The DHCP failover relationship. |
dhcpScopeRefs | ArrayOfObjRef | Yes | No | References to DHCP scopes that should be removed from the DHCP failover relationship. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveFromADSite
Removes the specified address ranges from the specified AD site.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
adSiteRef | ObjRef | Yes | No | Reference to the AD site from which the address ranges should be removed. |
rangeRefs | ArrayOfObjRef | Yes | No | References to the address ranges that should be removed from the AD site. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveFromCloudNetwork
Removes the specified address ranges from their respective cloud networks.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRefs | ArrayOfObjRef | Yes | No | References to the address ranges that should be removed from cloud networks. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveFromFolder
Removes the specified objects from the specified folder.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
folderRef | ObjRef | Yes | No | Reference to the folder from which the objects should be removed. |
objRefs | ArrayOfObjRef | Yes | No | References to the objects that should be removed from the folder. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveObject
Removes the specified object.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the object that should be removed. |
objType | ObjectType | No | No | The type of the object that should be removed. |
forceRemoval | boolean | No | No | If possible, then force removal of object. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveObjects
Removes the specified objects.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objRefs | ArrayOfObjRef | Yes | No | References for the objects that should be removed. |
objType | ObjectType | No | No | The type of the objects that should be removed. |
forceRemoval | boolean | No | No | If possible, then force removal of object. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfObjectError | Yes | Yes | Error messages. One error message is generated for each object that could not be successfully removed. |
RemovePropertyDefinition
Removes the specified custom property definition.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
objType | ObjectType | Yes | No | The object type to which the custom property definition is associated. |
property | string | Yes | No | The name of the custom property definition. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveRoleFromGroup
Removes a role from a group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
roleRef | ObjRef | Yes | No | A reference to the role to remove. |
groupRef | ObjRef | Yes | No | A reference to the group from which the role should be removed. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveRoleFromUser
Removes a role from a user.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
roleRef | ObjRef | Yes | No | A reference to the role to remove. |
userRef | ObjRef | Yes | No | A reference to the user from which the role should be removed.. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
RemoveUserFromGroup
Removes a user from a group.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
userRef | ObjRef | Yes | No | A reference to the user to remove. |
groupRef | ObjRef | Yes | No | A reference to the group from which the user should be removed. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ReplicateDHCPFailover
Replicate DHCP failover, either for each DHCP failover relationship on the DHCP server, for a specific DHCP failover relationship or for a specific DHCP scope.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | An object reference for the DHCP server. |
dhcpFailoverRelationshipName | string | No | No | DHCP failover relationship. |
dhcpScopeRef | ObjRef | No | No | An object reference for a DHCP scope. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
ReportAccess
Reports on access set for the specified identity (which must reference either a user or a group).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
identityRef | ObjRef | Yes | No | Object reference for a user or group. The command only retrieves access information for the specified user or group. |
identityType | ObjectType | No | No | The object type of the identity. |
objTypes | ArrayOfObjectType | Yes | No | List of object types for which to return access information. |
Response
Name | Type | Required | Nillable | Description |
---|
objectAccess | ArrayOfObjectAccess | Yes | Yes | Access information for the objects. |
ReportDHCPScopeOptions
Reports on DHCP scopes that either have or do not have the specified value or have no value set for the specified DHCP option.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
reportType | DHCPScopeOptionsReportType | Yes | No | Specifies the report type to return. |
option | unsignedInt | Yes | No | The option to query for. |
vendorClass | string | No | No | The vendor class to use. |
userClass | string | No | No | The user class to use. |
value | string | No | No | The value to query for. |
filter | string | No | Yes | Filtering criteria for the records returned. |
Response
ReportHostDiscovery
Reports on host discovery, either for hosts with data which have not been answering during discovery or for hosts without data which have answered during discovery.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
type | HostDiscoveryType | Yes | No | Specifies the report type to return. |
startDate | DateTime | No | No | The start date to use. |
subnetFilter | string | No | Yes | The subnet to use if the host list should return results for a given subnet. |
limit | unsignedInt | No | Yes | The maximum number of entries to return. |
Response
ReportIPFromClientIdentifier
Reports on DHCP reservations and DHCP leases that are associated with the specified client identifier.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
clientIdentifier | string | Yes | No | Specifies the MAC address or client identifier to search for. |
Response
Name | Type | Required | Nillable | Description |
---|
dhcpReservations | ArrayOfDHCPReservation | Yes | Yes | An array of DHCP reservations that match the client identifier. |
dhcpLeases | ArrayOfDHCPLease | Yes | Yes | An array of DHCP leases that match the client identifier. |
addresses | ArrayOfIPAddress | Yes | Yes | An array of IP addresses that are associated with either a DHCP lease or reservation that match the client identifier. |
ReportMergeAddressSpaces
Reports on possible conflicts and warnings when moving an object between address spaces.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
srcAddressSpaceRef | ObjRef | Yes | No | A reference to the source address space. |
destAddressSpaceRef | ObjRef | Yes | No | A reference to the destination address space. |
Response
ReportMultilabelHosts
Reports all A and AAAA records that have multiple labels in the name field.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
Response
RunCommand
Runs a command and returns the output.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
name | string | Yes | No | The command to run. |
parameters | string | No | Yes | Parameters for the command. |
interpreter | string | No | Yes | Optional interpreter. |
interpreterParameters | string | No | Yes | Optional interpreter parameters. |
Response
Name | Type | Required | Nillable | Description |
---|
output | string | No | Yes | The output of the command. |
SendMail
Sends an email message through an SMTP mail server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
smtpServer | string | Yes | No | The name of the SMTP mail server. |
from | string | Yes | No | The sender's email address. |
to | string | Yes | No | Comma separated list of recipient email addresses. |
cc | string | No | No | Comma separated list of email addresses for cc recipients. |
bcc | string | No | No | Comma separated list of email addresses for bcc recipients. |
subject | string | No | No | The subject of the email message. |
body | string | Yes | No | The body of the email message. |
SetCurrentAddressSpace
Switches over to the specified address space.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
addressSpaceRef | ObjRef | Yes | No | Reference to the address space to which should be switched. |
SetDHCPAddressPoolPermitList
Sets DHCP address pool permit list for the specified DHCP address pool.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpAddressPoolRef | ObjRef | Yes | No | Reference to the DHCP address pool for which to set the address pool permit list. |
dhcpAddressPoolPermits | ArrayOfDHCPAddressPoolPermit | Yes | Yes | The DHCP address pool permit list to set. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetDHCPOptions
Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the object for which to set the DHCP options. |
objType | ObjectType | No | No | The type of the object for which to set the DHCP options. |
ticket | unsignedInt | No | Yes | Ticket used for concurrency. Returned by GetDHCPOptions command and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail. |
dhcpOptions | ArrayOfDHCPOption | Yes | Yes | The DHCP options to set. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetDHCPPolicyEnforcement
Gets DHCP policy enforcement as set for the specified owner (which must reference a DHCP server or a DHCP scope).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ownerRef | ObjRef | Yes | No | A reference to the DHCP server/scope for which the DHCP policy enforcement is set. |
objType | ObjectType | No | No | The object type of the owner (i.e. either DHCP server or DHCP scope) |
enforce | boolean | Yes | No | Specifies whether DHCP policies should be enforced. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetDHCPSubclasses
Sets DHCP subclasses for the specified DHCP class on the specified DHCP server.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dhcpServerRef | ObjRef | Yes | No | Reference to the DHCP server on which the DHCP subclasses should be set. |
dhcpClassName | string | Yes | No | The name of the DHCP class for which the DHCP subclasses should be set. |
dhcpSubclasses | ArrayOfString | Yes | Yes | The DHCP subclasses to set. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetDNSRecordAging
Sets aging on or of for the specified record.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
dnsRecordRef | ObjRef | Yes | No | An object reference for the DNS record. |
aging | boolean | Yes | No | If true, then aging will be enabled for the record else it will be disabled. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
dnsRecord | DNSRecord | Yes | No | The changed DNS record object. |
SetIPAMRecord
Sets an IPAM record (i.e. apply changes to DNS, DHCP and/or IPAM for a specific IP address with one call).
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ipamRecordBefore | IPAMRecord | Yes | No | The IPAM record as it was before calling SetIPAMRecord. |
ipamRecordAfter | IPAMRecord | Yes | No | The IPAM record as it should be after calling SetIPAMRecord. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
forceOverrideOfNamingConflictCheck | boolean | No | No | Set to true to force creation of the records in the new IPAM record regardless of the naming conflict check (if enabled in system settings). |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfError | Yes | Yes | Error messages. One error message is generated for each change that could not be successfully applied. |
SetInheritAccess
Sets inheritAccess property for a range and/or its subranges
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | The range |
inheritAccess | boolean | No | No | Set inheritAccess flag on or off for the range |
inheritChildAccess | boolean | No | No | Set inheritAccess flag on or off for subranges of the range |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
errors | ArrayOfError | Yes | Yes | Error messages |
SetObjectAccess
Sets access for the specified objects.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
identityAccess | ArrayOfIdentityAccess | Yes | No | The access to set for the objects. |
objRefs | ArrayOfObjRef | Yes | No | References to the objects for which the access should be set. |
objType | ObjectType | No | No | The type of the objects for which the access should be set. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetPassword
Changes the password for the currently logged in user.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
oldPassword | string | Yes | No | The old password for the user. |
newPassword | string | Yes | No | The new password for the user. |
SetProperties
Sets properties for the specified object.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
ref | ObjRef | Yes | No | Reference to the object for which properties should be set. |
objType | ObjectType | No | No | The type of the object for which properties should be set. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
deleteUnspecified | boolean | No | No | Set to true if properties that are not explicitly set should be cleared. Default value is false. |
properties | ArrayOfProperty | Yes | No | The properties and property values that should be set for the object. |
SetRoutersForRange
Sets routers for the specified address range.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | Reference to the address range for which the routers should be set. |
addresses | ArrayOfIPAddress | Yes | Yes | IP addresses of the routers. |
recursive | boolean | No | No | Specifies whether a router address should be placed in child subnet if the address belongs to the subnet. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetServiceStatus
.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
serverRef | ObjRef | Yes | No | An object reference for the DNS server. |
serviceStatus | ServiceStatus | Yes | No | The service status. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
SetSystemSettings
Sets system settings.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
systemSettings | ArrayOfSystemSetting | Yes | Yes | The system settings that should be set. |
SplitRange
Splits the specified address range into new subranges.
Arguments
Name | Type | Required | Nillable | Description |
---|
session | string | Yes | No | Session ID from the Login command. |
rangeRef | ObjRef | Yes | No | Reference to the address range that should be split. |
cidr | unsignedInt | Yes | No | Determines the size of the resulting subranges, e.g. to split an address range into /24 subranges the value 24 would be used. |
subnet | boolean | No | No | Determines if the new subranges should be defined as subnets. |
locked | boolean | No | No | Determines if the new subranges should be set as locked. |
autoAssign | boolean | No | No | Determines if it should be possible to automatically assign IP addresses from the new subranges. |
customProperties | ArrayOfProperty | No | No | The custom properties for the new subranges. |
discovery | Discovery | No | No | The discovery (ping) schedule that should be set for the new subranges. |
saveComment | string | No | Yes | Save comment text to associate with the action. |
Response
Name | Type | Required | Nillable | Description |
---|
ranges | ArrayOfRange | Yes | No | The new subranges. |