Skip to end of metadata
Go to start of metadata

Introduction

This document describes the Men & Mice web service API. The SOAP interface was introduced in Version 6.2 of the Men & Mice Suite. The web service allows administrators and software developers to create custom scripts and applications on top of the Men & Mice suite to manage DNS, DHCP and IP address infrastructures of all sizes. Most features available in the Men & Mice suite are available through the web service interface.

The web service can be used to perform tasks such as:

  • Configure and work with Bind, Microsoft and Unbound DNS servers
  • Work with DNS zones and records
  • Configure ISC and Microsoft DHCP servers
  • Work with DHCP scopes, pools and reservations
  • IP address management (IPAM)
  • and much more

Version 7.1 contains several new commands and some commands and object types have been modified. A list of new commands and changes to existing commands and object types can be found in the section API Change Log.


Important: Version 7.1 of the Men & Mice Suite contains changes to both commands and object types. If you are using the SOAP interface for Version 6.3, we strongly recommend that you review the API Change Log for information on these changes.

On-line SOAP Documentation

Starting with Version 6.3.1, the SOAP command reference can be viewed on-line directly from Men & Mice Central. The SOAP documentation URL is:
http://api.menandmice.com/
OR
http://service_hostname/menandmice/soapdoc.htm

  • service_hostname is the fully qualified domain name of the web server that is running the Men and Mice Web Interface (and the SOAP service).

This assumes the default port 80 for the Web Interface and that Men and Mice Central is running on the same machine as the service_hostname. If that is not the case, replace "localhost" with the address of M&M Central in the forwarded URL.

Code Examples

The Men & Mice knowledgebase contains a demonstration of the usage of many of the SOAP commands using PowerShell, Python and Perl. It also includes custom-built wrappers/classes to greatly ease the interaction of those scripting languages with the M&M SOAP API. To view these examples, look at http://kb.menandmice.com using the keyword "SOAP". 

 

The document starts with a general description of how to use the web service, followed by a more detailed description for different data types and methods in the API.

Men & Mice SOAP API

Table of contents

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
    [servername:]scopename
    or
    [servername:]cidr
  • For views, the reference can be in the format
    [servername:]viewname

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:

<filter>mycorp</filter>

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

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringNoNoThe name of the AD Forest.
catalogServerstringNoYesGlobal catalog server to which the Men & Mice Suite connects for retrieving sites and subnets.
userNamestringNoYesUser name used when connecting to the global catalog server.
passwordstringNoYesPassword used when connecting to the global catalog server.
readOnlybooleanNoNoDetermines if the forest is read-only.

ArrayOfADForest

Elements

ADReplicationType

Defines possible replication types for an AD integrated zone.

Enumerations

NameDescription
NoneNo replication.
To_All_DNS_Servers_In_AD_ForrestReplicate to all DNS servers in an AD forest.
To_All_DNS_Servers_In_AD_DomainReplicate to all DNS servers in an AD domain.
To_All_Domain_Controllers_In_AD_DomainReplicate to all domain controllers in an AD domain.
To_All_Domain_Controllers_In_Specified_PartitionReplicate to all domain controllers in a specified partition.
UnavailableReplication is unavailable.

ADSite

Contains all properties for an AD Site object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the AD Site.
descriptionstringYesYesA description of the AD Site.
locationstringYesYesThe location of the AD Site.
adForestRefObjRefYesNoA reference to the AD Forest to which the AD Site belongs.

ArrayOfADSite

Elements

Contains all properties for an AD Site Link object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the AD Site Link.
descriptionstringNoYesA description of the AD Site Link.
costunsignedIntNoNoA metric used by AD to determine which site links have precedent over other site links.
replIntervalunsignedIntNoNoReplication interval. Defines the interval (in minutes) between performing AD replications.
siteListArrayOfStringNoYesList of AD Sites that this Site Link links together.
adForestRefObjRefYesNoA reference to the AD Forest to which the AD Site Link belongs.

Elements

AccessEntry

Contains the name and setting for an access entry relevant to an object.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the access entry.
accessAccessTypeYesNoThe setting for the access entry.

ArrayOfAccessEntry

Elements

AccessType

Defines possible access for an object property.

Enumerations

NameDescription
UnspecifiedNo access specified.
AllowAllow access.
DenyDeny access.

Address

Contains all properties for an address.

Elements

NameTypeRequiredNillableDescription
idunsignedIntYesNoUnique identifier for the address.
addressstringYesNoThe address.
claimedbooleanYesNoDetermines whether the address is claimed.
hoststringYesYesComma separated list of fully qualified DNS host names associated with the address.
lastseenunsignedIntYesNoTimestamp when the address was last seen during discovery (ping).
lastdiscoveryunsignedIntYesNoTimestamp when discovery (ping) was last performed for the address.
customPropertiesArrayOfPropertyYesYesThe custom properties for the address.

ArrayOfAddress

Elements

AddressBlock

Contains all properties for an address block.

Elements

NameTypeRequiredNillableDescription
fromIPAddressYesNoThe starting IP address of the address block.
toIPAddressYesNoThe ending IP address of the address block.

ArrayOfAddressBlock

Elements

AddressSpace

Contains all properties for an address space object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the address space.
descriptionstringNoYesA description of the address space.

ArrayOfAddressSpace

Elements

AddressUtilizationHistory

Address utilization data that has been aggregated by date.

Elements

NameTypeRequiredNillableDescription
timestampunsignedIntYesNoTimestamp that includes the date aggregated by.
measurecountunsignedIntYesNoThe number of measurements that were aggregated.
meanunsignedIntYesNoThe mean of aggregated numbers.
maxunsignedIntYesNoThe max of aggregated numbers.
minunsignedIntYesNoThe min of aggregated numbers.

AddressUtilizationHistorySeries

Contains address utilization data that has been aggregated as part of history calculations.

Elements

NameTypeRequiredNillableDescription
isdynamicunsignedIntYesNoStates if the data is for the static or dynamic part of an address range.
sizeunsignedIntYesNoTotal number of addresses for the requested address range.
availableAddressesunsignedIntYesNoNumber of available addresses within an address range.
addressUtilizationHistoryAddressUtilizationHistoryNoNoAddress utilization data aggregated by date.

AddressUtilizationRecent

Address utilization measurement.

Elements

NameTypeRequiredNillableDescription
timestampunsignedIntYesNoTimestamp that signals when the measurements were taken.
valueunsignedIntYesNoThe 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

NameTypeRequiredNillableDescription
isdynamicunsignedIntYesNoStates if the data is for the static or dynamic part of an address range.
sizeunsignedIntYesNoTotal number of addresses for the requested address range.
availableAddressesunsignedIntYesNoNumber of available addresses within an address range.
addressUtilizationRecentAddressUtilizationRecentNoNoAddress utilization measurement.

ApplianceState

Defines possible Appliance states.

Enumerations

NameDescription
UnknownUnknown appliance state.
OKAppliance is OK.
UnreachableAppliance is offline or otherwise unreachable.
Out of dateAppliance has a different version than Central.
Wrong typeAppliance is of a wrong type.
UpdatingAppliance is being updated.
Service DownAppliance is down and not responding.

AuthenticationType

Defines possible authentication types for a user that is logging in.

Enumerations

NameDescription
InternalInternal authentication.
ADActive Directory authentication.
ADGroupActive Directory group-level authentication.
RADIUSRADIUS authentication.

CachedDNSEntry

Contains an entry from a DNS cache.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the DNS record.
datastringYesNoContains the record data in a tab-separated list.
typeDNSRecordTypeYesNoSpecifies the type of the DNS record.
ttlstringYesNoSpecifies the Time-To-Live of the DNS record.
agingunsignedIntNoNoThe aging timestamp of dynamic records in AD integrated zones.
negativebooleanNoNoTrue if the cache entry is a negative cache entry.

ArrayOfCachedDNSEntry

Elements

ChangeRequest

Contains all properties for a change request object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
requesterstringYesNoThe name of the user that made the change request.
stateChangeRequestStateYesNoThe state of the change request.
creationDateDateTimeYesNoThe date and time, when the change request was created.
objTypeObjectTypeYesNoThe type of object being requested. Currently limited to DNSRecord and DHCPReservation objects.
requestDateDateTimeNoNoThe date and time, when the change request should be applied, if specified.
customPropertiesArrayOfPropertyYesYesThe custom properties for the change request.
saveCommentstringYesYesSave comment text to associate with the action.
processedDateDateTimeNoNoThe date and time, when the change request was approved or rejected.
dnsZoneChangesArrayOfDNSZoneChangeNoNoDNS zone changes associated with the change request.
dnsRecordChangesArrayOfDNSRecordChangeNoNoDNS record changes associated with the change request.
dhcpScopeChangesArrayOfDHCPScopeChangeNoNoDHCP scope changes associated with the change request.
dhcpReservationChangesArrayOfDHCPReservationChangeNoNoDHCP reservation changes associated with the change request.
dhcpExclusionChangesArrayOfDHCPExclusionChangeNoNoDHCP exclusion changes associated with the change request.
dhcpAddressPoolChangesArrayOfDHCPAddressPoolChangeNoNoDHCP address pool changes associated with the change request.
dhcpOptionChangesArrayOfDHCPOptionChangeNoNoDHCP option changes associated with the change request.

ArrayOfChangeRequest

Elements

ChangeRequestState

Defines possible change request states.

Enumerations

NameDescription
PendingPending approval/rejection.
ApprovedApproved, waiting to be applied.
RejectedRejected.
AppliedApplied.
FailedFailed to be applied.

ChangeType

Defines possible change types.

Enumerations

NameDescription
AddAdd.
ModifyModify.
RemoveRemove.

Cloud

Contains all properties for a cloud object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the cloud.
typeCloudTypeYesNoThe type of the cloud.
serverNodestringYesNoThe server node with which to communicate.
usernamestringYesNoThe username to use for authenticating with cloud.
passwordstringYesYesThe password to use for authenticating with cloud.
httpsRequiredbooleanYesNoIs HTTPS required for communicating with server node.
customPropertiesArrayOfPropertyNoYesThe custom properties for the cloud.

ArrayOfCloud

Elements

CloudNetwork

Contains all properties for a cloud network object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the cloud network.
cloudRefObjRefYesNoReference for the cloud to which the cloud network belongs.
customPropertiesArrayOfPropertyNoYesThe custom properties for the cloud network.

ArrayOfCloudNetwork

Elements

CloudSubnet

Contains all properties for a cloud subnet associated with a range.

Elements

NameTypeRequiredNillableDescription
rangeRefObjRefYesNoReference to the address range associated with the cloud subnet.
allocationPoolsArrayOfAddressBlockNoYesSpecifies 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

NameDescription
UnknownUnknown cloud type.
OpenStackOpenStack cloud.
CloudStackCloudStack cloud

CustomFilter

Contains all properties for a custom filter object.

Elements

NameTypeRequiredNillableDescription
idunsignedIntNoNoA unique ID for the object.
typeunsignedIntNoNoThe object type for the filter.
namestringYesNoThe name of the filter.
filterstringYesNoThe filter string.
folderRefstringNoYesIf 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.
readOnlybooleanYesNoTrue if the filter read only, else false.

ArrayOfCustomFilter

Elements

DCHPScopeOptionsReportEntry

Contains information about DHCP scopes returned by DHCP scope options report.

Elements

NameTypeRequiredNillableDescription
dhcpServerNamestringYesNoThe name of the DHCP server containing the DHCP scope.
dhcpScopeNamestringYesNoThe name of the DHCP scope.
optionValuestringYesYesThe option value set for the DHCP scope.
inheritedbooleanYesNoSpecifies whether the option value is inherited.

ArrayOfDCHPScopeOptionsReportEntry

Elements

DHCPAddressPool

Contains all properties for a DHCP address pool object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringNoNoThe name of the DHCP address pool.
fromIPAddressNoNoThe start address of the DHCP address pool.
toIPAddressNoNoThe end address of the DHCP address pool.
failoverPeerstringNoNoThe name of the failover peer if the address pool is on an ISC DHCP server with failover peer(s) defined.
failoverRelationshipstringNoNoThe name of the failover relationship if the address pool is on an MS DHCP server with failover(s) defined. Read-only property.
dhcpScopeRefObjRefYesNoA 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

NameTypeRequiredNillableDescription
typeChangeTypeYesNoThe type of the DHCP address pool change.
stateChangeRequestStateNoNoThe state of the DHCP address pool change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DHCP address pool change.
changeIndexunsignedIntNoNoThe index of the DHCP address pool change within the change request which contains the DHCP address pool change.
dhcpAddressPoolBeforeDHCPAddressPoolNoNoThe DHCP address pool as it was when the DHCP address pool change was made (omitted when type is Add).
dhcpAddressPoolAfterDHCPAddressPoolNoNoThe 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

NameTypeRequiredNillableDescription
permitDHCPAddressPoolPermitTypeYesNoThe DHCP address pool permit type.
accessAccessTypeYesNoThe DHCP address pool access type.
classNamestringNoNoThe name of the DHCP class if permit type is MembersOfDHCPClass.

ArrayOfDHCPAddressPoolPermit

Elements

DHCPAddressPoolPermitType

Defines the types of DHCP Address Pool permits.

Enumerations

NameDescription
UnknownUnknown DHCP address pool permit.
AllClientsDHCP address pool permit for all clients.
KnownClientsDHCP address pool permit for known clients.
UnknownClientsDHCP address pool permit for unknown clients.
DynamicBOOTPClientsDHCP address pool permit for dynamic BOOTP clients.
MembersOfDHCPClassDHCP address pool permit for members of a DHCP class.

DHCPConcurrentLease

Contains information about a concurrent lease.

Elements

NameTypeRequiredNillableDescription
dhcpServerRefObjRefYesNoReference to the DHCP server containing the concurrent lease.
dhcpServerNamestringYesNoName of the DHCP server containing the concurrent lease.
dhcpScopeRefObjRefYesNoReference to the DHCP scope containing the concurrent lease.
dhcpScopeNamestringYesNoName of the DHCP scope containing the concurrent lease.
namestringYesYesName of the concurrent lease.
typestringYesYesType of the concurrent lease.
macstringYesNoMAC address of the concurrent lease.
addressIPAddressYesNoIP address of the concurrent lease.
leasestringYesNoDuration of the concurrent lease.
statestringYesYesState of the concurrent lease.

ArrayOfDHCPConcurrentLease

Elements

DHCPExclusion

Contains all properties for a DHCP exclusion object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringNoNoThe name of the DHCP exclusion.
fromIPAddressNoNoThe start address of the DHCP exclusion.
toIPAddressNoNoThe end address of the DHCP exclusion.
dhcpScopeRefObjRefYesNoA unique reference ID of the scope that contains the exclusion.

ArrayOfDHCPExclusion

Elements

DHCPExclusionChange

Contains all properties for a DHCP exclusion change object.

Elements

NameTypeRequiredNillableDescription
typeChangeTypeYesNoThe type of the DHCP exclusion change.
stateChangeRequestStateNoNoThe state of the DHCP exclusion change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DHCP exclusion change.
changeIndexunsignedIntNoNoThe index of the DHCP exclusion change within the change request which contains the DHCP exclusion change.
dhcpExclusionBeforeDHCPExclusionNoNoThe DHCP exclusion as it was when the DHCP exclusion change was made (omitted when type is Add).
dhcpExclusionAfterDHCPExclusionNoNoThe DHCP exclusion as it should be after the DHCP exclusion change has been applied (omitted when type is Remove).

ArrayOfDHCPExclusionChange

Elements

DHCPFailoverDeconfigureAction

Defines possible actions when removing DHCP scopes from a failover relationship.

Enumerations

NameDescription
NoneNo action.
DisableDisable scopes.
DeleteRemove scopes.

DHCPFailoverMode

Defines possible DHCP failover modes.

Enumerations

NameDescription
LoadBalanceLoad Balance.
HotStandbyHot Standby.

DHCPFailoverRelationship

Defines a DHCP failover relationship.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the DHCP failover relationship.
primaryServerstringYesNoThe primary DHCP server.
secondaryServerstringYesNoThe secondary DHCP server.
failoverModeDHCPFailoverModeYesNoThe DHCP failover mode to use.
failoverServerTypeDHCPFailoverServerTypeYesNoA set of possible values for a DHCPv4 server in a failover relationship.
mcltunsignedIntYesNoMaximum client lead time in seconds.
safePeriodunsignedIntYesNoSafe period time in seconds, that the DHCPv4 server will wait before transitioning the server from the COMMUNICATION-INT state to PARTNER-DOWN.
dhcpScopeRefsArrayOfObjRefYesYesReferences to DHCP scopes that are associated with the failover relationship.
percentageunsignedIntYesNoIndicates the ratio of the DHCPv4 client load shared between a primary and secondary server in the failover relationship.
sharedSecretstringNoNoThe shared secret key associated with this failover relationship.
dhcpServerRefObjRefNoNoAn object reference for the DHCP server.

ArrayOfDHCPFailoverRelationship

Elements

DHCPFailoverServerType

Defines the types of DHCP Failover server.

Enumerations

NameDescription
PrimaryServerThe server is a primary server in the failover relationship.
SecondaryServerThe server is a secondary server in the failover relationship.

DHCPGroup

Contains all properties for a DHCP group object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the DHCP group.
parentRefObjRefNoNoAn object reference to the parent group of the DHCP group.
ownerRefObjRefYesNoA reference to the owning object.

ArrayOfDHCPGroup

Elements

DHCPLease

Contains all properties for a DHCP lease object.

Elements

NameTypeRequiredNillableDescription
namestringYesYesThe name of the lease.
typestringNoNoThe DHCP lease type.
macstringYesNoThe MAC address of the host that holds the lease.
addressIPAddressYesNoThe IP address of the lease.
leasestringYesNoThe expiration date for the lease.
statestringYesYesThe state of the lease.
dhcpScopeRefObjRefYesNoA unique reference ID of the scope that contains the lease.

ArrayOfDHCPLease

Elements

DHCPLeaseField

Defines the fields of a DHCP lease.

Enumerations

NameDescription
IPAddressIP address field.
ClientIdentifierClient identifier field.
ServerAddressServer address field.
HostnameHostname field.
DescriptionDescription field.

DHCPLeaseHistoryEntry

Contains information about a DHCP lease.

Elements

NameTypeRequiredNillableDescription
serverAddressstringYesNoThe IP address of the server.
eventCodestringYesYesEvent code.
timestampfirstDateTimeYesYesFirst timestamp associated with the DHCP lease.
timestamplastDateTimeNoYesLast timestamp associated with the DHCP lease.
ipAddressstringYesYesThe IP address of the DHCP lease.
clientidentifierstringYesYesThe client identifier of the DHCP lease.
hostnamestringYesYesThe hostname of the DHCP lease.
numberOfOccurrancesstringNoYesNumber of occurrences of the DHCP lease.

ArrayOfDHCPLeaseHistoryEntry

Elements

DHCPLeaseReference

Contains all properties for a DHCP lease.

Elements

NameTypeRequiredNillableDescription
dhcpScopeRefObjRefYesNoReference to the DHCP scope that contains the lease.
leaseIPAddressYesNoIP address for the lease.

ArrayOfDHCPLeaseReference

Elements

DHCPOption

Contains a single DHCP option value.

Elements

NameTypeRequiredNillableDescription
optionstringYesNoThe DHCP option ID.
valuestringNoYesThe DHCP option value.

ArrayOfDHCPOption

Elements

DHCPOptionChange

Contains all properties for a DHCP option change object.

Elements

NameTypeRequiredNillableDescription
stateChangeRequestStateNoNoThe state of the DHCP option change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DHCP option change.
changeIndexunsignedIntNoNoThe index of the DHCP option change within the change request which contains the DHCP option change.
ownerObjectYesNoThe owner (object) to which the DHCP option change should be applied.
dhcpOptionDHCPOptionYesNoThe 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

NameTypeRequiredNillableDescription
namestringYesNoThe DHCP option class name.
descriptionstringNoYesThe DHCP option class description.
identifierstringYesNoThe DHCP option class identifier.

ArrayOfDHCPOptionClass

Elements

DHCPOptionDefinition

Contains a definition for a DHCP option.

Elements

NameTypeRequiredNillableDescription
optionstringYesNoThe DHCP option ID.
namestringYesNoThe DHCP option name.
typePropertyTypeYesNoThe DHCP option type.
arraybooleanYesNoDetermines whether DHCP option is defined as an array.

ArrayOfDHCPOptionDefinition

Elements

DHCPPolicy

Contains all properties for a DHCP policy.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the DHCP policy.
descriptionstringNoYesA description for the DHCP policy.
orderunsignedIntNoNoSpecifies the relative order in which the DHCP policy will be processed.
enabledbooleanNoNoSpecifies whether the DHCP policy is enabled (default true).
logicalOperatorDHCPPolicyLogicalOperatorYesNoThe logical operation to be performed between the DHCP policy conditions.
conditionsArrayOfDHCPPolicyConditionNoYesConditions set for the DHCP policy.
rangesArrayOfDHCPPolicyRangeNoYesIP ranges set for the DHCP policy.

ArrayOfDHCPPolicy

Elements

DHCPPolicyComparisonType

Defines possible DHCP policy comparison types.

Enumerations

NameDescription
EqualComparison of whether values are equal.
NotEqualComparison of whether values are not equal.

DHCPPolicyCondition

Contains all properties for a DHCP policy condition.

Elements

NameTypeRequiredNillableDescription
conditionTypeDHCPPolicyConditionTypeYesNoThe type of the DHCP policy condition.
comparisonTypeDHCPPolicyComparisonTypeYesNoThe type of comparison to be performed on the DHCP policy condition attribute.
valuesArrayOfStringYesNoThe 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

NameDescription
MACAddressMAC address.
VendorClassVendor class.
UserClassUser class.
ClientIdentifierClient identifier.
RelayAgentInformationRelay agent information.
RAIAgentCircuitIDRelay agent information - Agent circuit ID.
RAIAgentRemoteIDRelay agent information - Agent remote ID.
RAISubscriberIDRelay agent information - Subscriber ID.

DHCPPolicyLogicalOperator

Defines possible DHCP policy logical operators.

Enumerations

NameDescription
LogicalOrLogical OR operator.
LogicalAndLogical AND operator.

DHCPPolicyRange

Contains all properties for a DHCP policy range.

Elements

NameTypeRequiredNillableDescription
fromIPAddressYesNoThe starting IP address of the DHCP policy range.
toIPAddressYesNoThe ending IP address of the DHCP policy range.

ArrayOfDHCPPolicyRange

Elements

DHCPRefAndFailoverRelationshipName

A DHCP failover relationship to remove.

Elements

NameTypeRequiredNillableDescription
dhcpServerRefObjRefNoNoAn object reference for the DHCP server.
dhcpFailoverRelationshipNamestringYesYesName of the DHCP failover relationship to remove.

DHCPReservation

Contains all properties for a DHCP reservation object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringNoNoThe name of the reservation.
clientIdentifierstringNoYesThe client identifier used for the reservation (e.g. the MAC address).
addressesArrayOfIPAddressNoYesAn array of zero or more IP addresses used for the reservation.
typeDHCPReservationTypeNoNoThe type of the DHCP reservation.
reservationMethodDHCPReservationMethodNoNoThe method used to identify the DHCP reservation.
descriptionstringNoYesDescription for the reservation. Only applicable for MS DHCP servers.
ddnsHostNamestringNoYesDynamic DNS host name for reservation. Only applicable for ISC DHCP servers.
filenamestringNoYesThe "filename" DHCP option. Only applicable for ISC DHCP servers.
serverNamestringNoYesThe "server-name" DHCP option. Only applicable for ISC DHCP servers.
nextServerstringNoYesThe "next-server" ISC DHCP option. Only applicable for ISC DHCP servers.
ownerRefObjRefYesNoA 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

NameTypeRequiredNillableDescription
typeChangeTypeYesNoThe type of the DHCP reservation change.
stateChangeRequestStateNoNoThe state of the DHCP reservation change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DHCP reservation change.
changeIndexunsignedIntNoNoThe index of the DHCP reservation change within the change request which contains the DHCP reservation change.
dhcpReservationBeforeDHCPReservationNoNoThe DHCP reservation as it was when the DHCP reservation change was made (omitted when type is Add).
dhcpReservationAfterDHCPReservationNoNoThe 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

NameDescription
HardwareAddressHardware address.
ClientIdentifierClient identifier.

DHCPReservationType

Defines possible DHCP reservation types.

Enumerations

NameDescription
DHCPDHCP reservation type.
BOOTPBOOTP reservation type.
BOTHBoth DHCP and BOOTP reservation types.

DHCPScope

Contains all properties for a DHCP scope object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the DHCP scope.
rangeRefObjRefYesNoA reference to the range associated with the scope.
dhcpServerRefObjRefYesNoA reference to the DHCP server containing the scope.
superscopestringNoYesThe name of the superscope for the DHCP scope. Only applicable for MS DHCP servers.
descriptionstringNoYesA description for the DHCP scope.
availableunsignedIntNoNoNumber of available addresses in the address pool(s) of the scope.
enabledbooleanNoNoSpecifies whether the scope is enabled (default true).

ArrayOfDHCPScope

Elements

DHCPScopeChange

Contains all properties for a DHCP scope change object.

Elements

NameTypeRequiredNillableDescription
typeChangeTypeYesNoThe type of the DHCP scope change.
stateChangeRequestStateNoNoThe state of the DHCP scope change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DHCP scope change.
changeIndexunsignedIntNoNoThe index of the DHCP scope change within the change request which contains the DHCP scope change.
dhcpScopeBeforeDHCPScopeNoNoThe DHCP scope as it was when the DHCP scope change was made (omitted when type is Add).
dhcpScopeAfterDHCPScopeNoNoThe 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

NameDescription
HasValueReport on DHCP scopes that have the specified value for the specified DHCP option.
DoesNotHaveValueReport on DHCP scopes that do not have the specified value for the specified DHCP option.
HasNoValueSetReport on DHCP scopes that have no value set for the specified DHCP option.

DHCPScopeReconcileEntry

Contains information about DHCP scope reconcile entries.

Elements

NameTypeRequiredNillableDescription
scopeAddressIPAddressYesNoThe IP address of the DHCP scope.
addressIPAddressYesNoThe IP address that requires reconciling.
flagDHCPScopeReconcileFlagYesYesThe DHCP scope reconcile flag set for this entry.

ArrayOfDHCPScopeReconcileEntry

Elements

DHCPScopeReconcileFlag

Defines possible DHCP scope reconcile flags.

Enumerations

NameDescription
ReconcileRegistryEntry found in database but not in registry.
ReconcileDatabaseEntry found in registry but not in database.

DHCPServer

Contains all properties for a DHCP server object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the DHCP server.
proxystringNoNoThe DHCP server controller used to connect to the DHCP server.
addressIPAddressNoNoThe IP address of the DHCP server.
resolvedAddressIPAddressNoNoThe IP address of the DHCP server, if specified, or the IP address retrieved through resolving the name of the DHCP server.
usernamestringNoYesThe login name of the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.
passwordstringNoYesThe password for the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.
enablePasswordstringNoYesThe password for entering maintenance mode when accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.
typeDHCPServerTypeYesNoThe DHCP server type.
stateDHCPServerStateNoNoThe state of the DHCP Server.
securityDHCPServerSecurityNoYesThe login method used for the DHCP server. Only applicable for Cisco IOS DHCP servers.
customPropertiesArrayOfPropertyNoYesThe custom properties for the DHCP server.
enabledbooleanNoNoSpecifies whether the DHCP server is enabled.

ArrayOfDHCPServer

Elements

DHCPServerSecurity

Defines possible login methods for Cisco IOS DHCP servers.

Enumerations

NameDescription
UnknownUnknown login method.
TelnetLogin using Telnet.
SSH2Login using SSH2.

DHCPServerState

Defines possible DHCP server states.

Enumerations

NameDescription
UnknownUnknown DHCP server state.
OKDHCP Server is OK.
UnreachableDHCP Server Controller is offline or otherwise unreachable.
Out of dateDHCP Server Controller has a different version than Central.
Wrong typeDHCP Server type does not match type specified.
UpdatingDHCP Server Controller version is being updated.
Service DownDHCP server service is down and DHCP server is not answering clients.
DisabledDHCP server is disabled.

DHCPServerType

Defines possible DHCP server types.

Enumerations

NameDescription
UnknownUnknown DHCP server.
MSDHCPMicrosoft DHCP server.
ISCISC DHCP server.
IOSCisco IOS DHCP server.
KEA DHCPv4KEA DHCPv4 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

NameTypeRequiredNillableDescription
dnsServerRefObjRefYesNoA reference to the DNS server containing the cached DNS records.
cachedDNSEntriesArrayOfCachedDNSEntryYesNoDNS entries cached on the server.
dnsViewRefObjRefYesNoContains 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

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
rangeStartunsignedIntYesNoThe start of the range.
rangeEndunsignedIntYesNoThe end of the range.
rangeStepunsignedIntNoNoThe stepping of the range. Defaults to 1.
lhsstringYesYesThe owner name of the resource records generated by the directive.
ttlstringNoYesThe ttl of the resource records generated by the directive.
classstringNoYesThe class of the resource records generated by the directive.
typeDNSRecordTypeYesNoThe type of the resource records generated by the directive.
rhsstringYesYesThe 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

NameTypeRequiredNillableDescription
dnsRecordDNSRecordYesNoThe DNS host record. The record must be an address (A) record. Note that the name element of the record is fully qualified here.
ptrStatusPTRStatusNoNoThe PTR record status for the host record.
relatedRecordsArrayOfDNSRecordYesYesAn array of records associated with the host record.

ArrayOfDNSHost

Elements

DNSRecord

Contains all properties for a DNS record object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesYesThe name of the DNS record, either partially or fully qualified.
typeDNSRecordTypeYesNoSpecifies the type of the DNS record.
ttlstringYesYesSpecifies the Time-To-Live of the DNS record.
datastringYesYesContains the record data in a tab-separated list.
commentstringNoYesContains the comment string for the record. Note that only records in static DNS zones can have a comment string.
enabledbooleanYesNoContains true if the record is enabled. If the record is disabled the value is false.
agingunsignedIntNoNoThe aging timestamp of dynamic records in AD integrated zones.
dnsZoneRefObjRefYesNoContains the reference ID of the zone that contains the record.

ArrayOfDNSRecord

Elements

DNSRecordChange

Contains all properties for a DNS record change object.

Elements

NameTypeRequiredNillableDescription
typeDNSRecordChangeTypeYesNoThe type of the DNS record change.
stateChangeRequestStateNoNoThe state of the DNS record change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DNS record change.
changeIndexunsignedIntNoNoThe index of the DNS record change within the change request which contains the DNS record change.
dnsRecordBeforeDNSRecordNoNoThe DNS record as it was when the DNS record change was made (omitted when type is AddDNSRecord).
dnsRecordAfterDNSRecordNoNoThe 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

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
requesterstringYesNoThe name of the user that made the change request.
stateChangeRequestStateYesNoThe state of the change request.
creationDateDateTimeYesNoThe date and time, when the change request was created.
requestDateDateTimeNoNoThe date and time, when the change request should be applied, if specified.
customPropertiesArrayOfPropertyYesYesThe custom properties for the change request.
saveCommentstringYesYesSave comment text to associate with the action.
processedDateDateTimeNoNoThe date and time, when the change request was approved or rejected.
dnsRecordChangesArrayOfDNSRecordChangeNoNoThe DNS record changes associated with the change request.

ArrayOfDNSRecordChangeRequest

Elements

DNSRecordChangeType

Defines possible DNS record change types.

Enumerations

NameDescription
AddDNSRecordAdd DNS record.
ModifyDNSRecordModify DNS record.
RemoveDNSRecordRemove DNS record.

DNSRecordType

Defines possible DNS record types.

Enumerations

NameDescription
AnyAny record type.
UnknownUnknown record type.
AA (Address) record.
NSNS (Name Server) record.
CNAMECNAME (Canonical Name) record.
SOASOA (Start Of Authority) record.
WKSWKS (Well Known Services) record.
PTRPTR (Pointer) record.
HINFOHINFO (Host Information) record.
MXMX (Mail Exchange) record.
TXTTXT (Text) record.
SPFSPF (Sender Policy Framework) record.
RPRP (Responsible Person) record.
AFSDBAFSDB (AFS Database) record.
AAAAAAAA (IPv6 address) record.
LOCLOC (Location) record.
SRVSRV (Service Locator) record.
NAPTRNAPTR (Naming Authority Pointer) record.
DNAMEDNAME (Delegation Name) record.
WINSWINS (Windows Internet Server Name) record.
WINSRWINSR (WINS Reverse Lookup) record.
DSDS (Delegation Signer) record.
SSHFPSSHFP (SSH Public Key Fingerprint) record.
DHCIDDHCID (DHCP Identifier) record.
CERTCERT (Certificate) record.
RRSIGRRSIG (DNSSEC Signature) record.
DNSKEYDNSKEY (DNS Key) record.
NSECNSEC (Next-Secure) record.
NSEC3NSEC3 (NSEC version 3) record.
NSEC3PARAMNSEC3PARAM (NSEC3 parameters) record.
TLSATLSA (DANE) record

DNSServer

Contains all properties for a DNS server object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the DNS server.
proxystringNoNoThe DNS server controller used to connect to the DNS server.
addressIPAddressNoNoThe IP address of the DNS server.
resolvedAddressIPAddressNoNoThe IP address of the DNS server, if specified, or the IP address retrieved through resolving the name of the DNS server.
portunsignedIntNoNoThe port to use when connecting to the DNS server. Only needed if a non-standard port is used to connect to the server.
typeDNSServerTypeYesNoThe type of DNS server.
adForeststringNoNoThe name of the AD Forest with which the DNS server is associated.
stateDNSServerStateNoNoThe state of the DNS Server.
customPropertiesArrayOfPropertyNoYesThe custom properties for the DNS server.
subtypeDNSServerSubtypeNoNoThe subtype of DNS server.
enabledbooleanNoNoSpecifies whether the DNS server is enabled.

ArrayOfDNSServer

Elements

DNSServerState

Defines possible DNS server states.

Enumerations

NameDescription
UnknownUnknown DNS server state.
OKDNS Server is OK.
UnreachableDNS Server Controller is offline or otherwise unreachable.
Out of dateDNS Server Controller has a different version than Central.
UninitializedDNS Server has no data yet, is probably still synchronizing.
UpdatingDNS Server Controller version is being updated.
Service DownDNS server service is down and DNS server is not responding to queries.
DisabledDNS server is disabled.

DNSServerSubtype

Defines possible DNS server subtypes.

Enumerations

NameDescription
UnknownUnknown DNS server subtype.
Win2003Microsoft Windows 2003 DNS server.
Win2008Microsoft Windows 2008 DNS server.
Win2012Microsoft Windows 2012 DNS server.
Win2016Microsoft Windows 2016 DNS server.
BIND9ISC BIND DNS server.
UnboundThe unbound version.

DNSServerType

Defines possible DNS server types.

Enumerations

NameDescription
UnknownUnknown DNS server type.
MSMicrosoft DNS server.
BINDISC BIND DNS server.
UnboundUnbound DNS caching server.
GenericGeneric DNS server.
AzureAzure DNS server.

DNSView

Contains all properties for a DNS view object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesYesThe name of the DNS view.
dnsServerRefObjRefYesNoA reference to the server containing the view.

ArrayOfDNSView

Elements

DNSZone

Contains all properties for a DNS zone object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the DNS zone.
dynamicbooleanNoNoContains true if the zone is dynamic.
adIntegratedbooleanNoNoContains true if the zone is Active Directory integrated.
adReplicationTypeADReplicationTypeNoNoThe AD replication type if the zone is Active Directory integrated.
adPartitionstringNoYesThe AD partition if the zone is Active Directory integrated.
dnsViewRefObjRefNoNoContains the reference ID of the DNS view that contains the zone. This property is not supplied for AD integrated zones.
dnsViewRefsArrayOfObjRefNoNoContains the reference IDs of the DNS views that contain the zone.
authoritystringNoNoContains the name of the DNS server that contains the zone or the string "[Active Directory]" if the zone is AD integrated.
typeDNSZoneTypeYesNoSpecifies the type of the zone.
dnssecSignedbooleanNoNoContains true if the zone is a DNSSEC signed zone.
kskIDsstringNoYesA comma separated string of IDs of KSKs, starting with active keys, then inactive keys in parenthesis.
zskIDsstringNoYesA comma separated string of IDs of ZSKs, starting with active keys, then inactive keys in parenthesis.
customPropertiesArrayOfPropertyNoYesThe custom properties for the zone.

ArrayOfDNSZone

Elements

DNSZoneChange

Contains all properties for a DNS zone change object.

Elements

NameTypeRequiredNillableDescription
typeChangeTypeYesNoThe type of the DNS zone change.
stateChangeRequestStateNoNoThe state of the DNS zone change.
hasAccessbooleanNoNoSpecifies whether the user has access to approve/reject the DNS zone change.
changeIndexunsignedIntNoNoThe index of the DNS zone change within the change request which contains the DNS zone change.
dnsZoneBeforeDNSZoneNoNoThe DNS zone as it was when the DNS zone change was made (omitted when type is Add).
dnsZoneAfterDNSZoneNoNoThe DNS zone as it should be after the DNS zone change has been applied (omitted when type is Remove).

ArrayOfDNSZoneChange

Elements

DNSZoneType

Defines possible types for a DNS zone.

Enumerations

NameDescription
MasterMaster zone.
SlaveSlave zone.
HintHint zone.
StubStub zone.
ForwardForward zone.

DateTime

Date/time.

Device

Contains all properties for a device object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the device.
customPropertiesArrayOfPropertyNoYesThe custom properties for the device.
interfacesArrayOfInterfaceNoYesThe interfaces on the device.

ArrayOfDevice

Elements

Discovery

Contains all properties for a ping discovery schedule that is used for ranges or scopes.

Elements

NameTypeRequiredNillableDescription
intervalunsignedIntYesNoThe interval between runs for the discovery schedule.
unitTimeUnitYesNoThe time unit for the interval.

Event

Contains all properties for an event object.

Elements

NameTypeRequiredNillableDescription
eventTypeEventTypeYesNoEvent type.
objTypeObjectTypeYesNoObject type.
objRefObjRefYesNoReference to the object.
objNamestringYesYesName of the object.
timestampDateTimeYesNoTimestamp of event.
usernamestringYesYesName of the user associated with the event.
saveCommentstringYesYesSave comment provided along with the event.
eventTextstringYesYesDescription of the event.

ArrayOfEvent

Elements

EventType

Defines possible event types.

Enumerations

NameDescription
UnknownUnknown event type.
CreationObject creation event.
ModificationObject modification event.
DeletionObject deletion event.
RefreshRefresh event.
ErrorError event.
ReferenceReference event.

Folder

Contains all properties for a folder object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the folder.
contentTypeObjectTypeYesNoThe type of objects contained within the folder.
parentRefObjRefNoNoA reference to the parent folder.

ArrayOfFolder

Elements

Group

Contains all properties for a user group object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the group.
descriptionstringNoYesA description for the group.
adIntegratedbooleanNoNoContains true if the group is Active Directory integrated.
groupMembersArrayOfObjectNoYesAn array of references to the users in the group.
rolesArrayOfObjectNoYesAn 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

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the object for which this entry applies.
objTypeObjectTypeYesNoThe type of the object for which this entry applies.
namestringYesNoThe name of the object for which this entry applies.
hasAccessbooleanYesNoContains true if the user has access for the access entry.

ArrayOfHasAccessEntry

Elements

HexStr

Hexadecimal encoded string.

HostDiscoveryReportEntry

Contains information about host discovery.

Elements

NameTypeRequiredNillableDescription
addrRefObjRefYesNoReference to the host IP address.
addressstringYesNoThe host IP address.
dnsHostNamesstringYesYesComma separated list of DNS host names found for the IP address.
lastSeenDateDateTimeYesNoThe date when the host address last responded to a ping request.
lastDiscoveryDateDateTimeYesNoThe date when the system last checked whether the host address responded to a ping request.
lastKnownClientIdentifierstringYesYesThe MAC address associated with the IP address discovery info.
discoveryTypeIPAddressDiscoveryTypeYesNoThe type of IP address discovery that is the source of the IP address discovery info.
customPropertiesArrayOfPropertyYesYesThe custom properties associated with the host address.

ArrayOfHostDiscoveryReportEntry

Elements

HostDiscoveryType

Defines possible host discovery report types.

Enumerations

NameDescription
HostsWithDataReport on hosts with data which have not been answering during discovery.
HostsWithoutDataReport on hosts without data which have answered during discovery.

IPAMRecord

Contains all properties for an IPAM record object.

Elements

NameTypeRequiredNillableDescription
addrRefObjRefYesNoA reference to the IP address.
addressstringYesNoThe IP address.
claimedbooleanYesNoContains true if the record has the Claimed flag set. Obsolete, replaced by state.
dnsHostsArrayOfDNSHostYesYesList of DNS hosts associated with the address.
dhcpReservationsArrayOfDHCPReservationYesYesList of DHCP reservations associated with the address.
dhcpLeasesArrayOfDHCPLeaseYesYesList of DHCP leases associated with the address.
discoveryTypeIPAddressDiscoveryTypeYesNoThe type of IP address discovery that is the source of the IP address discovery info.
lastSeenDatestringYesYesThe date when the address was last seen during IP address discovery.
lastDiscoveryDatestringYesYesThe date when the system last performed IP address discovery for this IP address.
lastKnownClientIdentifierstringYesYesThe MAC address associated with the IP address discovery info.
devicestringNoYesThe device associated with the record.
interfacestringNoYesThe interface associated with the record.
ptrStatusPTRStatusNoNoThe PTR record status for the record.
extraneousPTRbooleanNoNoContains true if there are extraneous PTR records for the record.
customPropertiesArrayOfPropertyYesYesThe custom properties for the IPAM record.
stateIPAMRecordStateNoNoSpecifies the IP address state.
usageunsignedIntNoNoIP address usage bitmask.

ArrayOfIPAMRecord

Elements

IPAMRecordState

Defines possible IPAM record states.

Enumerations

NameDescription
FreeIP address is free.
AssignedIP address is assigned.
ClaimedIP address is claimed.

IPAddress

IPv4/IPv6 address.

ArrayOfIPAddress

Elements

IPAddressDiscoveryType

Defines possible IP address discovery types.

Enumerations

NameDescription
NoneIP address has no discovery info.
PingIP address answered ping during scheduled discovery.
ARPIP address was present in a router's ARP cache.
LeaseIP address had a DHCP lease.
CustomIP 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

NameTypeRequiredNillableDescription
identityRefObjRefYesNoA unique reference ID for a user or group for which the access applies.
identityNamestringNoNoThe name of the user or group for which the access applies.
accessEntriesArrayOfAccessEntryYesYesThe access entries for the user or group.

ArrayOfIdentityAccess

Elements

Interface

Contains all properties for an interface object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the interface.
clientIdentifierstringNoYesThe client identifier for the interface.
addressesArrayOfIPAddressNoYesThe addresses for the interface.
customPropertiesArrayOfPropertyNoYesThe custom properties for the interface.
deviceRefObjRefNoNoA 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

NameDescription
WarningWarning.
ErrorError.

MergeAddressSpacesReportEntry

Contains information about a merge address space conflict.

Elements

NameTypeRequiredNillableDescription
conflictTypeMergeAddressSpacesReportConflictTypeYesNoConflict type.
srcObjRefObjRefYesNoA reference to an object in the source address space.
destObjRefObjRefYesNoA reference to a conflicting object in the destination address space.
descriptionstringYesNoConflict description.

ArrayOfMergeAddressSpacesReportEntry

Elements

MultiLabelHostReportEntry

Contains information about a host in the multi-label host report.

Elements

NameTypeRequiredNillableDescription
refObjRefYesNoRef of the DNS record.
namestringYesNoThe name of the DNS record, partially qualified.
zonenamestringYesNoThe name of the zone.
typeDNSRecordTypeYesNoSpecifies the type of the DNS record.
datastringYesNoContains the record data in a tab-separated list.

ArrayOfMultiLabelHostReportEntry

Elements

NetworkDiscoveryInfo

Contains Network Discovery Info.

Elements

NameTypeRequiredNillableDescription
routerNamestringNoNoThe name of the router.
gatewayIPAddressNoNoThe IP address of the gateway.
interfaceIDunsignedIntNoNoThe interface ID.
interfaceNamestringNoNoThe interface name.
VLANIDunsignedIntNoNoThe VLAN ID for the interface.
interfaceDescriptionstringNoYesThe interface description.
VRFNamestringNoYesThe VRF name assigned to the interface.

ArrayOfNetworkDiscoveryInfo

Elements

ObjRef

A reference to an object.

ArrayOfObjRef

Elements

Object

Contains information about a generic object.

Elements

NameTypeRequiredNillableDescription
refObjRefYesNoA reference to the object.
objTypeObjectTypeNoNoThe type of the object.
namestringNoNoThe name of the object.

ArrayOfObject

Elements

ObjectAccess

Contains information about an object access entry.

Elements

NameTypeRequiredNillableDescription
refObjRefYesNoA reference to the object.
namestringYesNoThe name of the object.
identityAccessArrayOfIdentityAccessNoYesAn 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

NameTypeRequiredNillableDescription
refObjRefYesNoA reference to the object.
errorstringYesNoThe error string.

ArrayOfObjectError

Elements

ObjectType

Defines possible object types.

Enumerations

NameDescription
UnknownUnknown object type.
SuiteThe Men and Mice Suite.
DNSServerDNS server.
DHCPServerDHCP server.
DNSZoneDNS zone.
DNSViewDNS view.
RangeIP Address range.
DHCPScopeDHCP scope.
IPAddressIP address.
DHCPReservationDHCP reservation.
DHCPAddressPoolDHCP address pool.
DHCPGroupDHCP group.
ADSiteActive Directory site.
DNSRecordDNS resource record.
UserUser.
GroupGroup.
DHCPExclusionDHCP exclusion.
DHCPFailoverPeerDHCP failover peer.
DHCPLeaseDHCP lease.
DeviceDevice.
InterfaceInterface for a device.
FolderFolder.
ADSiteLinkActive Directory site link.
AddressSpaceAddress space.
ADForestActive Directory forest.
ChangeRequestChange request.
ApplianceA Men & Mice Appliance.
RoleRole.
CloudCloud.
CloudNetworkCloud network.
SuperscopeSuperscope.

ArrayOfObjectType

Elements

PTRStatus

Defines possible status types for PTR records.

Enumerations

NameDescription
UnknownUnknown status.
OKNo errors found mapping the PTR record.
VerifyErrors or inconsistencies found when mapping the PTR record.

Property

Contains a single property entry for an object.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the property.
valuestringNoYesThe value of the property.

ArrayOfProperty

Elements

PropertyDefinition

Contains the property definition for a property.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the property.
typePropertyTypeYesNoThe type of the property.
systembooleanNoNoContains true if the property is system defined.
mandatorybooleanNoNoDetermines if the property is mandatory.
readOnlybooleanNoNoDetermines if the property is read-only.
multiLinebooleanNoNoDetermines if the property is multi-line.
defaultValuestringNoYesContains the default value for the property.
listItemsArrayOfStringNoYesContains the list items if the property is an enumeration.
parentPropertystringNoNoName of the parent property.

ArrayOfPropertyDefinition

Elements

PropertyType

Defines the possible data types for a custom property.

Enumerations

NameDescription
StringFree form string.
HexStrHexadecimal encoded string.
BooleanBoolean.
IPAddressIPv4/IPv6 address.
IPOrHostnameIPv4/IPv6 address or a legal host name.
IntegerInteger.

Range

Contains all properties for a range object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the range.
fromIPAddressNoNoThe starting IP address of the range.
toIPAddressNoNoThe ending IP address of the range.
parentRefObjRefNoNoA reference to the immediate parent range.
adSiteRefObjRefNoNoA reference to the AD site to which the range belongs.
childRangesArrayOfObjectNoYesAn array of child ranges of the range.
dhcpScopesArrayOfObjectNoYesAn array of scopes associated with the range.
subnetbooleanNoNoDetermines if the range is defined as a subnet.
lockedbooleanNoNoDetermines if the range should be set as locked.
autoAssignbooleanNoNoDetermines if it should be possible to automatically assign IP addresses from the range.
hasSchedulebooleanNoNoDetermines if a discovery schedule has been set for the range.
hasMonitorbooleanNoNoDetermines if monitoring is enabled for the range.
customPropertiesArrayOfPropertyNoYesThe custom properties for the range.
inheritAccessbooleanNoNoShould this range inherit its access bits from its parent range?.
isContainerbooleanNoNoSet to true to create a container instead of a range.
utilizationPercentageunsignedIntNoNoUtilization percentage for range.
hasRogueAddressesbooleanNoNoIf this range is a container, then this member will indicate whether there are rogue addresses in the container.
cloudNetworkRefObjRefNoNoA reference to the cloud network to which the range belongs.
cloudAllocationPoolsArrayOfAddressBlockNoYesAddresses in subnet which should be available for dynamic allocation in the cloud.
discoveredPropertiesArrayOfNetworkDiscoveryInfoNoYesNetwork Discovery Information.
creationTimeDateTimeNoYesThe time when the Range was created.

ArrayOfRange

Elements

RangeWithStatistics

Contains a range object along with statistics for that range.

Elements

NameTypeRequiredNillableDescription
rangeRangeYesNoThe range object.
usedstringYesNoNumber of used IP addresses in the range.
freestringYesNoNumber of free IP addresses in the range.
utilizationintYesNoUtilization percentage for the range.

ArrayOfRangeWithStatistics

Elements

Role

Contains all properties for a role object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe name of the role.
descriptionstringNoYesA description for the role.
usersArrayOfObjectNoYesAn array of references to users that have the role.
groupsArrayOfObjectNoYesAn array of references to groups that have the role.

ArrayOfRole

Elements

ServiceStatus

The state of a service.

Enumerations

NameDescription
undefinedStatus is undefined.
runningThe service is running.
stoppedThe service is stopped.
exitedThe service has exited.
fatalThe service is dead.

SortOrder

Defines sorting order for a list.

Enumerations

NameDescription
AscendingSort order ascending.
DescendingSort order descending.

SourcedDHCPOptions

Contains DHCP options from a single source.

Elements

NameTypeRequiredNillableDescription
sourceObjectYesNoThe source of the DHCP options.
dhcpOptionsArrayOfDHCPOptionYesYesThe DHCP options.

ArrayOfSourcedDHCPOptions

Elements

SubdomainHandling

How existing subdomains of subnets that are being updated should be handled.

Enumerations

NameDescription
IgnoreSkip reverse records in subdomains.
UpdateUpdate reverse records in subdomains as well.

SystemSetting

Contains a single system setting value.

Elements

NameTypeRequiredNillableDescription
namestringYesNoThe name of the system setting.
valuestringNoYesThe value of the system setting.

ArrayOfSystemSetting

Elements

TimeUnit

Defines possible time units.

Enumerations

NameDescription
MinutesMinutes.
HoursHours.
DaysDays.
WeeksWeeks.
MonthsMonths.

TransportProtocol

Defines possible transports protocols.

Enumerations

NameDescription
UDPUDP over an IPv4 connection.
TCPTCP over an IPv4 connection.
UDP6UDP over an IPv6 connection.
TCP6TCP over an IPv6 connection.

User

Contains all properties for a user object.

Elements

NameTypeRequiredNillableDescription
refObjRefNoNoA unique reference ID for the object.
namestringYesNoThe login name of the user.
passwordstringNoYesThe user password.
fullNamestringNoYesThe full name of the user.
descriptionstringNoYesThe description for the user.
emailstringNoYesThe users email address.
authenticationTypeAuthenticationTypeYesNoThe authentication type for the user.
groupsArrayOfObjectNoYesAn array of the groups the user is a member of.
rolesArrayOfObjectNoYesAn array of the roles the user has.

ArrayOfUser

Elements

ZoneSet

An instance of the zones that were created.

Elements

NameTypeRequiredNillableDescription
masterRefObjRefYesNoA unique reference ID for the zone.
slaveZoneRefsArrayOfObjRefNoYesA list of unique reference IDs for the slave zones that were created.

ZoneSets

Contains the zones that were created.

Elements

NameTypeRequiredNillableDescription
zoneSetZoneSetNoNoAn instance of a zone that was created.

Commands

AddADForest

Adds a new AD forest.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adForestADForestYesNoThe AD forest to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added AD forest.

AddADSite

Adds a new AD site.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteADSiteYesNoThe AD site to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added AD site.

Adds a new AD site link.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteLinkADSiteLinkYesNoThe AD site link to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added AD site link.

AddAddressSpace

Adds a new address space.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addressSpaceAddressSpaceYesNoThe address space to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added address space.

AddChangeRequest

Adds request for change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneChangesArrayOfDNSZoneChangeNoYesDNS zone change(s).
dnsRecordChangesArrayOfDNSRecordChangeNoYesDNS record change(s).
dhcpScopeChangesArrayOfDHCPScopeChangeNoYesDHCP scope change(s).
dhcpReservationChangesArrayOfDHCPReservationChangeNoYesDHCP reservation change(s).
dhcpExclusionChangesArrayOfDHCPExclusionChangeNoYesDHCP exclusion change(s).
dhcpAddressPoolChangesArrayOfDHCPAddressPoolChangeNoYesDHCP address pool change(s).
dhcpOptionChangesArrayOfDHCPOptionChangeNoYesDHCP options change(s).
requestDateDateTimeNoYesThe date and time, when the requested change(s) should be applied, if specified.
customPropertiesArrayOfPropertyNoYesThe custom properties for the change request.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added change request.

AddCloud

Adds a new cloud.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
cloudCloudYesNoThe cloud to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added cloud.

AddCloudNetwork

Adds a new cloud network.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
cloudNetworkCloudNetworkYesNoThe cloud network to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added cloud network.

AddDHCPAddressPool

Adds a new DHCP address pool.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpAddressPoolDHCPAddressPoolYesNoThe DHCP address pool to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP address pool.

AddDHCPExclusion

Adds a new DHCP exclusion.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpExclusionDHCPExclusionYesNoThe DHCP exclusion to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP exclusion.

AddDHCPFailoverRelationship

Adds a DHCP failover relationship.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpFailoverRelationshipDHCPFailoverRelationshipYesNoThe DHCP failover relationship to add.
saveCommentstringNoYesSave comment text to associate with the action.

AddDHCPGroup

Creates a DHCP group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpGroupDHCPGroupYesNoThe DHCP group to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP Group.

AddDHCPOptionDefinition

Adds a new DHCP option definition on the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoThe DHCP server on which the option definition should be added.
dhcpOptionDefinitionDHCPOptionDefinitionYesNoThe DHCP option definition to add.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope to which the DHCP policy should be added.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).
dhcpPolicyDHCPPolicyYesNoThe DHCP policy to add.
saveCommentstringNoYesSave comment text to associate with the action.

AddDHCPReservation

Adds a new DHCP reservation.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpReservationDHCPReservationYesNoThe DHCP reservation to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP reservation.

AddDHCPScope

Adds a new DHCP scope.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeDHCPScopeYesNoThe DHCP scope to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP scope.

AddDHCPScopesToDHCPFailoverRelationship

Add DHCP scope(s) to a DHCP failover relationship.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.
dhcpFailoverRelationshipNamestringYesNoThe DHCP failover relationship.
dhcpScopeRefsArrayOfObjRefYesNoReferences to DHCP scopes that should be added to the DHCP failover relationship.
saveCommentstringNoYesSave comment text to associate with the action.

AddDHCPServer

Adds a new DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerDHCPServerYesNoThe DHCP server to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DHCP server.
warningstringNoNoWarning message returned if the added DHCP server is e.g. of an old or unknown version.

AddDNSGenerateDirective

Adds a new DNS generate directive.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoAn object reference for the DNS zone.
dnsGenerateDirectiveDNSGenerateDirectiveYesNoThe DNS generate directive to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DNS generate directive.

AddDNSRecord

Adds a new DNS record.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordDNSRecordYesNoThe DNS record to add.
saveCommentstringNoYesSave comment text to associate with the action.
autoAssignRangeRefObjRefNoNoA reference to a range that should be used for automatic assignment of IP addresses.
forceOverrideOfNamingConflictCheckbooleanNoNoSet to true to force creation of record regardless of naming conflict check (if enabled in system settings).

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DNS record.

AddDNSRecordChangeRequest

Adds request for DNS record change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordChangesArrayOfDNSRecordChangeYesNoThe requested DNS record change(s).
requestDateDateTimeNoYesThe date and time, when the requested DNS record change(s) should be applied, if specified.
customPropertiesArrayOfPropertyNoYesThe custom properties for the change request.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DNS record change request.

AddDNSRecords

Adds multiple new DNS records.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordsArrayOfDNSRecordYesNoThe DNS records to add.
saveCommentstringNoYesSave comment text to associate with the action.
autoAssignRangeRefObjRefNoNoA reference to a range that should be used for automatic assignment of IP addresses.
forceOverrideOfNamingConflictCheckbooleanNoNoSet to true to force creation of record regardless of naming conflict check (if enabled in system settings).

Response

NameTypeRequiredNillableDescription
objRefsArrayOfObjRefYesNoReferences to the added DNS records. If a record was not successfully added, the reference returned for that record will be {#0-#0}.
errorsArrayOfErrorYesYesError messages. One error message is generated for each record that is not added.

AddDNSServer

Adds a new DNS server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerDNSServerYesNoThe DNS server to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DNS server.

AddDNSZone

Adds a new DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneDNSZoneYesNoThe DNS zone to add.
mastersArrayOfIPAddressNoNoThe IP addresses of the master servers if the new zone is not a master zone.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added DNS zone.

AddDNSZones

Adds DNS Zones.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
namesArrayOfStringYesNoList of zone names.
adIntegratedbooleanNoYesContains true if the zone is Active Directory integrated.
dynamicbooleanNoYesContains true if the zone is dynamic.
adReplicationTypeADReplicationTypeNoYesThe AD replication type if the zone is Active Directory integrated.
adPartitionstringNoYesThe AD partition if the zone is Active Directory integrated.
masterViewRefObjRefYesNoReference to the master server view.
customPropertiesArrayOfPropertyNoYesThe custom properties for the zone.
slaveServerViewRefsArrayOfObjRefNoYesReference to the slave server views.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
zoneSetsZoneSetsYesYesList of created zones.

AddDevice

Adds a new device.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
deviceDeviceYesNoThe device to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added device.

AddFolder

Adds a new folder.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
folderFolderYesNoThe folder to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added folder.

AddGroup

Adds a new user group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
groupGroupYesNoThe group to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added group.

AddInterface

Adds a new interface.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
interfaceInterfaceYesNoThe interface to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added interface.

AddLicenseKey

Adds a new license key to the system.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
licenseKeystringYesNoThe license key to add.

AddPropertyDefinition

Adds a new custom property definition.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objTypeObjectTypeYesNoThe object type for which the custom property definition should be added.
propertyDefinitionPropertyDefinitionYesNoThe custom property definition to add.
saveCommentstringNoYesSave comment text to associate with the action.

AddRange

Adds a new address range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRangeYesNoThe address range to add.
discoveryDiscoveryNoNoThe discovery (ping) schedule that should be set for the address range.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added address range.

AddRole

Adds a new role.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRoleYesNoThe role to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added role.

AddRoleToGroup

Adds a role to a group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRefObjRefYesNoA reference to the role to add.
groupRefObjRefYesNoA reference to the group to which the role should be added.
saveCommentstringNoYesSave comment text to associate with the action.

AddRoleToUser

Adds a role to a user.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRefObjRefYesNoA reference to the role to which the user should be added.
userRefObjRefYesNoA reference to the user to add.
saveCommentstringNoYesSave comment text to associate with the action.

AddUser

Adds a new user.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
userUserYesNoThe user to add.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the added user.

AddUserToGroup

Adds a user to a group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
userRefObjRefYesNoA reference to the user to add.
groupRefObjRefYesNoA reference to the group to which the user should be added.
saveCommentstringNoYesSave comment text to associate with the action.

ApproveChanges

Approve change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
changeRequestRefObjRefYesNoAn object reference for the change request.
dnsZoneChangesArrayOfDNSZoneChangeNoNoRequested DNS zone change(s).
dnsRecordChangesArrayOfDNSRecordChangeNoNoRequested DNS record change(s).
dhcpScopeChangesArrayOfDHCPScopeChangeNoNoRequested DHCP scope change(s).
dhcpReservationChangesArrayOfDHCPReservationChangeNoNoRequested DHCP reservation change(s).
dhcpExclusionChangesArrayOfDHCPExclusionChangeNoNoRequested DHCP exclusion change(s).
dhcpAddressPoolChangesArrayOfDHCPAddressPoolChangeNoNoRequested DHCP address pool change(s).
dhcpOptionChangesArrayOfDHCPOptionChangeNoNoRequested DHCP option change(s).
saveCommentstringNoYesSave comment text to associate with the action.

ApproveDNSRecordChanges

Approves DNS record change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordChangeRequestRefObjRefYesNoAn object reference for the DNS record change request.
dnsRecordChangesArrayOfDNSRecordChangeYesNoThe requested DNS record change(s).
saveCommentstringNoYesSave comment text to associate with the action.

FlushFromCacheOnDNSServers

Flushes a single or all DNS entries from cache on given servers.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerRefsArrayOfObjRefYesNoAn array of object references for the DNS servers.
entrystringNoYesEntry to be flushed from cache. If no entry is specified, then the entire cache is flushed.
flushRecursivelybooleanNoYesRecursively flush the entire domain.
saveCommentstringNoYesSave comment text to associate with the action.

ForceSynchronization

Sends an synchronization request to the specified address.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference to the object to request sync for.
objTypeObjectTypeNoNoThe type of the object for which to set the DHCP options.

Response

NameTypeRequiredNillableDescription
syncTimeunsignedIntYesNoThe synchronization time in milliseconds. -1 if failure.

GenerateReverseRecords

Generates or updates reverse records.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
subnetsArrayOfStringYesNoSubnets or reverse zones for which reverse records should be generated/updated.
viewNamestringNoYesView for which reverse records should be generated/updated.
subdomainHandlingSubdomainHandlingYesNoHow existing subdomains of subnets that are being updated should be handled.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
errorsArrayOfStringNoYesNon-fatal errors that occurred during the update process.

GetADForest

Gets specified AD forest.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adForestRefObjRefYesNoThe object reference for the AD Forest.

Response

NameTypeRequiredNillableDescription
adForestADForestYesNoThe AD Forest object.

GetADForests

Gets AD forests.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
adForestsArrayOfADForestYesYesList of AD Forests.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetADPartitions

Gets AD partitions from the specified DNS server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerRefObjRefYesNoA reference to the DNS server from which to retrieve the Active Directory partitions.

Response

NameTypeRequiredNillableDescription
adPartitionsArrayOfStringYesYesList of Active Directory partitions.

GetADSite

Gets specified AD site.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteRefObjRefYesNoThe object reference for the AD Site.

Response

NameTypeRequiredNillableDescription
adSiteADSiteYesNoThe AD Site object.

Gets specified AD site link.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteLinkRefObjRefYesNoThe object reference for the AD Site Link.

Response

NameTypeRequiredNillableDescription
adSiteLinkADSiteLinkYesNoThe AD Site Link object.

Gets AD site links.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
adSiteLinksArrayOfADSiteLinkYesYesList of AD Site Links.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetADSites

Gets AD sites.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
adSitesArrayOfADSiteYesYesList of AD Sites.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetAddressBlocks

Gets specified address range's address blocks.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoReference to the address range.

Response

NameTypeRequiredNillableDescription
addressBlocksArrayOfAddressBlockYesYesAddress range's address blocks.

GetAddressSpace

Gets specified address space.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addressSpaceRefObjRefYesNoThe object reference for the address space.

Response

NameTypeRequiredNillableDescription
addressSpaceAddressSpaceYesNoThe address space object.

GetAddressSpaces

Gets address spaces.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
addressSpacesArrayOfAddressSpaceYesYesList of address spaces.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetAddressesInUse

Gets addresses in use within the specified address range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
lastseenDiscoveryNoNoUsed to filter by the time each address was last seen during discovery (ping).
rangesArrayOfRangeTitleYesNoNames of the address ranges in which to look for addresses.

Response

NameTypeRequiredNillableDescription
addressesArrayOfAddressYesYesAddresses that are considered to be in use in the specified address ranges.

GetAvailableAddressBlocks

Gets available address blocks within the specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoAn object reference for the range.
limitunsignedIntNoNoThe number of address blocks to return.
maskunsignedIntNoNoThe minimum size of the address blocks, specified as a subnet mask.
sizeunsignedIntNoNoThe minimum size of the address blocks, specified as the number of addresses.
ignoreSubnetFlagbooleanNoNoDetermines whether the subnet flag should be ignored when determining the size of the address blocks.
startAddressIPAddressNoNoThe starting address to use when looking for the next available address block. Ignored when mask is not provided.

Response

NameTypeRequiredNillableDescription
addressBlocksArrayOfAddressBlockYesYesArray of address blocks fulfilling the given criteria.

GetChangeRequest

Gets specified change request.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
changeRequestRefObjRefYesNoAn object reference for the change request.

Response

NameTypeRequiredNillableDescription
changeRequestChangeRequestYesNoThe change request object.

GetChangeRequests

Gets change requests.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
includeChangesbooleanNoNoSpecifies whether changes should be included in the result.
includeProcessedRequestsbooleanNoNoSpecifies whether change requests that have already been processed should be included in the result.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
changeRequestsArrayOfChangeRequestYesYesList of change requests.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetCloud

Gets a cloud object based on the object reference.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
cloudRefObjRefYesNoAn object reference for the cloud.

Response

NameTypeRequiredNillableDescription
cloudCloudYesNoThe cloud object.

GetCloudNetwork

Gets a cloud network object based on the object reference.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
cloudNetworkRefObjRefYesNoAn object reference for the cloud network.

Response

NameTypeRequiredNillableDescription
cloudNetworkCloudNetworkYesNoThe cloud network object.

GetCloudNetworks

Gets a list of cloud networks.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
cloudNetworksArrayOfCloudNetworkYesYesList of cloud networks.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetClouds

Gets a list of clouds.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
cloudsArrayOfCloudYesYesList of clouds.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetCurrentAddressSpace

Gets address space that the user is currently in.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

Response

NameTypeRequiredNillableDescription
addressSpaceRefObjRefYesNoA reference to the current address space.

GetCustomFilters

Gets a list of custom filters.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

Response

NameTypeRequiredNillableDescription
filtersArrayOfCustomFilterYesYesList of filters.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPAddressPool

Gets specified DHCP address pool.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpAddressPoolRefObjRefYesNoAn object reference for the DHCP address pool.

Response

NameTypeRequiredNillableDescription
dhcpAddressPoolDHCPAddressPoolYesNoThe DHCP address pool object.

GetDHCPAddressPoolPermitList

Gets DHCP address pool permit list for the specified DHCP address pool.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpAddressPoolRefObjRefYesNoAn object reference for the DHCP address pool from which to get the address pool permit list.

Response

NameTypeRequiredNillableDescription
dhcpAddressPoolPermitsArrayOfDHCPAddressPoolPermitYesYesList of DHCP address pool permits.

GetDHCPAddressPools

Gets DHCP address spools.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeRefObjRefNoNoA reference to the scope containing the address pool(s).
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpAddressPoolsArrayOfDHCPAddressPoolYesYesList of DHCP address pools.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPBackupStatus

Gets backup status for the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.

Response

NameTypeRequiredNillableDescription
dhcpBackupExistsbooleanYesNoDetermines whether a backup exists for the DHCP server.
dhcpBackupTimestampDateTimeYesNoContains the timestamp for the latest backup.

GetDHCPClassNames

Gets DHCP class names from the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.

Response

NameTypeRequiredNillableDescription
dhcpClassNamesArrayOfStringYesYesAn array of DHCP class names.

GetDHCPConcurrentLeases

Gets concurrent leases.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

Response

NameTypeRequiredNillableDescription
dhcpConcurrentLeasesArrayOfDHCPConcurrentLeaseYesYesAn array of leases active in more than one location.

GetDHCPExclusion

Gets specified DHCP exclusion.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpExclusionRefObjRefYesNoAn object reference for the DHCP exclusion.

Response

NameTypeRequiredNillableDescription
dhcpExclusionDHCPExclusionYesNoThe DHCP exclusion object.

GetDHCPExclusions

Gets DHCP exclusions.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeRefObjRefNoNoA reference to the scope containing the exclusion(s).
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpExclusionsArrayOfDHCPExclusionYesYesList of DHCP exclusions.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPFailoverRelationship

Get a DHCP failover relationship.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.
dhcpFailoverRelationshipNamestringYesNoThe DHCP failover relationship to retrieve.

Response

NameTypeRequiredNillableDescription
dhcpFailoverRelationshipDHCPFailoverRelationshipYesNoThe DHCP failover relationship retrieved.

GetDHCPFailoverRelationships

Get all DHCP failover relationships from specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefNoNoAn object reference for the DHCP server.

Response

NameTypeRequiredNillableDescription
dhcpFailoverRelationshipsArrayOfDHCPFailoverRelationshipYesYesThe DHCP failover relationships retrieved.

GetDHCPGroup

Gets specified DHCP group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpGroupRefObjRefYesNoAn object reference for the DHCP group.

Response

NameTypeRequiredNillableDescription
dhcpGroupDHCPGroupYesNoThe DHCP group object.

GetDHCPGroups

Gets DHCP groups from the specified owner (which must reference either a DHCP server or a DHCP scope).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the object containing the DHCP group(s).
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpGroupsArrayOfDHCPGroupYesYesList of DHCP groups.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPLeaseHistory

Gets DHCP lease history matching the specified field and filter.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
fieldDHCPLeaseFieldYesNoThe field by which to filter.
filterstringYesNoFiltering criteria for the records returned.
exactMatchbooleanNoNoSet to true if the field should match the filter exactly.
collapseRenewbooleanNoNoSet to true if renew entries should be collapsed into a single lease history entry.
startDateDateTimeNoYesDate of the first entry to retrieve.
endDateDateTimeNoYesDate of the last entry to retrieve.
limitunsignedIntNoNoThe number of records to return.

Response

NameTypeRequiredNillableDescription
dhcpLeaseHistoryEntriesArrayOfDHCPLeaseHistoryEntryYesYesArray of lease history entries fulfilling the search criteria.

GetDHCPLeases

Gets DHCP leases from the specified DHCP scope.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeRefObjRefYesNoA reference to the scope containing the leases.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpLeasesArrayOfDHCPLeaseYesYesList of DHCP leases.
totalResultsunsignedIntYesNoTotal 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoA reference to the object from which to get the DHCP option definitions.
objTypeObjectTypeNoNoThe type of the object from which to get the DHCP option definitions.

Response

NameTypeRequiredNillableDescription
dhcpOptionDefinitionsArrayOfDHCPOptionDefinitionYesYesThe option definitions.

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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoA reference to the object from which to get the DHCP options.
objTypeObjectTypeNoNoThe type of the object from which to get the DHCP options.

Response

NameTypeRequiredNillableDescription
ticketunsignedIntYesNoTicket 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.
dhcpOptionsArrayOfDHCPOptionYesYesThe DHCP options.

GetDHCPPolicies

Get all DHCP policies from the specified owner (which must reference a DHCP server or a DHCP scope).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope containing the DHCP policies.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).

Response

NameTypeRequiredNillableDescription
dhcpPoliciesArrayOfDHCPPolicyYesYesThe 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope for which the DHCP policy enforcement is set.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).

Response

NameTypeRequiredNillableDescription
enforcingbooleanYesNoSpecifies whether DHCP policies are being enforced.

GetDHCPReservation

Gets specified DHCP reservation.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpReservationRefObjRefYesNoAn object reference for the DHCP reservation.

Response

NameTypeRequiredNillableDescription
dhcpReservationDHCPReservationYesNoThe 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/group/scope containing the reservations.
objTypeObjectTypeNoNoThe object type of the owner (i.e. one of DHCP server/group/scope).
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpReservationsArrayOfDHCPReservationYesYesList of DHCP reservations.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPScope

Gets specified DHCP scope.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeRefObjRefYesNoAn object reference for the DHCP scope.

Response

NameTypeRequiredNillableDescription
dhcpScopeDHCPScopeYesNoThe DHCP scope object.

GetDHCPScopes

Gets DHCP scopes.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpScopesArrayOfDHCPScopeYesYesList of DHCP scopes.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPServer

Gets specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.

Response

NameTypeRequiredNillableDescription
dhcpServerDHCPServerYesNoThe DHCP server object.

GetDHCPServers

Gets DHCP servers.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dhcpServersArrayOfDHCPServerYesYesList of DHCP servers.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDHCPSubclasses

Gets DHCP subclasses from the specified DHCP class on the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.
dhcpClassNamestringYesNoThe name of the DHCP class for which to retrieve the subclasses.

Response

NameTypeRequiredNillableDescription
dhcpSubclassesArrayOfStringYesYesAn array of DHCP subclasses.

GetDHCPVendorAndUserClasses

Gets DHCP vendor and user classes from the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.

Response

NameTypeRequiredNillableDescription
dhcpVendorClassesArrayOfDHCPOptionClassYesYesAn array of DHCP vendor classes.
dhcpUserClassesArrayOfDHCPOptionClassYesYesAn array of DHCP user classes.

GetDNSGenerateDirective

Gets specified DNS generate directive.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsGenerateDirectiveRefObjRefYesNoAn object reference for the DNS generate directive.

Response

NameTypeRequiredNillableDescription
dnsGenerateDirectiveDNSGenerateDirectiveYesNoThe DNS generate directive object.

GetDNSGenerateDirectives

Gets DNS generate directives from the specified DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoReference to the zone containing the generate directives.

Response

NameTypeRequiredNillableDescription
dnsGenerateDirectivesArrayOfDNSGenerateDirectiveYesYesList of DNS generate directives.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSPTRRecords

Gets all reverse PTR records for specified IP address.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addressIPAddressYesNoThe IP address.
dnsZoneRefObjRefYesNoReference to a forward zone.

Response

NameTypeRequiredNillableDescription
reverseRecordsArrayOfDNSRecordYesYesList of reverse records for the specified IP address.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSRecord

Gets specified DNS record.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordRefObjRefYesNoAn object reference for the DNS record.

Response

NameTypeRequiredNillableDescription
dnsRecordDNSRecordYesNoThe DNS record object.

GetDNSRecordChangeRequest

Gets specified DNS record change request.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordChangeRequestRefObjRefYesNoAn object reference for the DNS record change request.

Response

NameTypeRequiredNillableDescription
dnsRecordChangeRequestDNSRecordChangeRequestYesNoThe DNS record change request object.

GetDNSRecordChangeRequests

Gets DNS record change requests.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
includeDNSRecordChangesbooleanNoNoSpecifies whether DNS record changes should be included in the result.
includeProcessedRequestsbooleanNoNoSpecifies whether DNS record change requests that have already been processed should be included in the result.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dnsRecordChangeRequestsArrayOfDNSRecordChangeRequestYesYesList of DNS record change requests.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSRecords

Gets DNS records from the specified DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoReference to the zone containing the records.
filterstringNoYesFiltering criteria for the records returned.
hideNonAccessibleHostsbooleanNoNoIf set to true the resulting set will not contain records for which the user has no access.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dnsRecordsArrayOfDNSRecordYesYesList of records.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSRecordsInCaches

Get DNS records with a certain pattern that are cached on given DNS servers.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerRefsArrayOfObjRefNoYesList of DNS servers to search on.
dnsSearchPatternstringYesNoThe pattern to search for. Should be a fully qualified domain name.
limitunsignedIntNoNoThe number of records to return. A limit of zero returns all matched records.

Response

NameTypeRequiredNillableDescription
dnsCachesArrayOfDNSCacheYesYesList of DNS caches.
errorsArrayOfObjectErrorYesYesList 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addressIPAddressYesNoThe IP address.
dnsZoneRefObjRefYesNoReference to a forward zone.

Response

NameTypeRequiredNillableDescription
dnsZoneDNSZoneNoYesThe reverse DNS zone for the specified IP address.

GetDNSServer

Gets specified DNS server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerRefObjRefYesNoAn object reference for the DNS server.

Response

NameTypeRequiredNillableDescription
dnsServerDNSServerYesNoThe DNS server object.

GetDNSServers

Gets DNS servers.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dnsServersArrayOfDNSServerYesYesList of DNS servers.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSView

Gets specified DNS view.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsViewRefObjRefYesNoAn object reference for the DNS view.

Response

NameTypeRequiredNillableDescription
dnsViewDNSViewYesNoThe DNS view object.

GetDNSViews

Gets DNS views.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsServerRefObjRefNoNoA reference to the DNS server.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dnsViewsArrayOfDNSViewYesYesList of DNS server views.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDNSZone

Gets specified DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoAn object reference for the DNS zone.

Response

NameTypeRequiredNillableDescription
dnsZoneDNSZoneYesNoThe DNS zone object.

GetDNSZones

Gets DNS zones.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
dnsZonesArrayOfDNSZoneYesYesList of zones.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetDevice

Gets specified device.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
deviceRefObjRefYesNoThe object reference for the device.

Response

NameTypeRequiredNillableDescription
deviceDeviceYesNoThe device object.

GetDevices

Gets devices.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
devicesArrayOfDeviceYesYesList of devices.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetFolder

Gets specified folder.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
folderRefObjRefYesNoAn object reference for the folder.

Response

NameTypeRequiredNillableDescription
folderFolderYesNoThe folder object.

GetFolderForObject

Gets the folder that contains the specified object.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoA reference to the object for which to retrieve the containing folder.
objTypeObjectTypeNoNoThe object type.

Response

NameTypeRequiredNillableDescription
folderObjRefNoNoThe folder object.

GetFolders

Gets a list of folders.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
foldersArrayOfFolderYesYesList of folders.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetGroup

Gets a group object based on the object reference.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
groupRefObjRefYesNoAn object reference for the group.

Response

NameTypeRequiredNillableDescription
groupGroupYesNoThe group object.

GetGroups

Gets a list of user groups.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
groupsArrayOfGroupYesYesList of groups.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetHistory

Gets event history.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
eventTypeEventTypeNoNoThe type of event to retrieve. If not specified, entries for all event types are retrieved.
objTypeObjectTypeNoNoThe type of object to retrieve. If not specified, entries for all object types are retrieved.
objRefObjRefNoNoIf specified, only history entries for the specified object will be retrieved.
usernamestringNoYesThe login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.
startDateDateTimeNoYesDate of the first entry to retrieve.
endDateDateTimeNoYesDate of the last entry to retrieve.
filterstringNoYesFiltering criteria for the records returned.
limitunsignedIntNoNoThe number of records to return.

Response

NameTypeRequiredNillableDescription
eventsArrayOfEventYesYesList of events.

GetIPAMRecord

Gets IPAM record for the specified IP address.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addrRefObjRefYesNoAn object reference for the IPAM record.
requireRangeRefObjRefNoNoReference to a range in which the relevant IP address must reside, otherwise the GetIPAMRecord call will fail.
excludeDHCPbooleanNoNoSet to true to exclude DHCP data from result.

Response

NameTypeRequiredNillableDescription
ipamRecordIPAMRecordYesNoThe IPAM record object.

GetIPAMRecords

Gets IPAM records from a specific range or for specific IPAM records.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefNoNoA reference to the range containing the addresses. Specified when getting IPAM records from a specific range.
addrRefsArrayOfObjRefNoNoAn array of references to the IPAM records to retrieve. Specified when getting specific IPAM records.
includeRelatedDNSRecordsbooleanNoNoSet to true if IPAM record should include DNS records related to any DNS hosts returned.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
excludeDHCPbooleanNoNoSet to true to exclude DHCP data from result.

Response

NameTypeRequiredNillableDescription
ipamRecordsArrayOfIPAMRecordYesYesList of IPAM records.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetInheritAccess

Gets inherit access flag for the specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoA reference to the range.

Response

NameTypeRequiredNillableDescription
inheritAccessbooleanYesNoInherit 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoA reference to the object for which to get inherited DHCP options.
objTypeObjectTypeNoNoThe type of the object for which to get inherited DHCP options.

Response

NameTypeRequiredNillableDescription
inheritedDHCPOptionsArrayOfSourcedDHCPOptionsYesYesThe inherited DHCP options.

GetInterface

Gets specified interface.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
interfaceRefObjRefYesNoThe object reference for the interface.

Response

NameTypeRequiredNillableDescription
interfaceInterfaceYesNoThe interface object.

GetInterfaces

Gets interfaces.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
deviceRefObjRefNoNoA reference to the device containing the interfaces.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
interfacesArrayOfInterfaceYesYesList of interfaces.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetKeyStorageProviders

Gets specified DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoAn object reference for the DNS zone.

Response

NameTypeRequiredNillableDescription
keyStorageProvidersArrayOfStringYesNoContains a list of storage providers installed on the DNS server.

GetNextFreeAddress

Gets next free address from the specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoA reference to the address range from which to return the free address.
startAddressIPAddressNoNoThe starting address to use when looking for the next free address.
pingbooleanNoNoIf 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.
excludeDHCPbooleanNoNoSet to true to exclude DHCP data from result.
temporaryClaimTimeunsignedIntNoNoIf set, claims the next free address for the given time in seconds.

Response

NameTypeRequiredNillableDescription
addressIPAddressNoNoThe next free IP address in the address range.

GetNextFreeReservationAddress

Gets next free reservable address from the specified scope.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objRefObjRefYesNoA reference to the scope from which to return the free address.
startAddressIPAddressNoNoThe starting address to use when looking for the next free address.
considerExclusionRangebooleanNoNoDetermines whether to look for a free address in an excluded range inside the scope.

Response

NameTypeRequiredNillableDescription
addressIPAddressNoNoThe next reservable IP address in the scope.

GetObjectAccess

Gets access set for the specified object.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoA reference to the object.
objTypeObjectTypeNoNoThe type of the object.
identityRefObjRefNoNoObject reference for a user or group. If specified, the command only retrieves access for the specified user or group.
excludeBuiltinIdentitiesbooleanNoNoSet to true to exclude access for builtin users and groups.

Response

NameTypeRequiredNillableDescription
objectAccessObjectAccessYesNoObject access information.

GetObjects

Gets specified objects.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objRefsArrayOfObjRefYesNoArray of object references.
objTypeObjectTypeNoNoThe type of the object.

Response

NameTypeRequiredNillableDescription
objectsArrayOfObjectYesYesList of objects.

GetOrphanReverseDNSRecords

Gets orphan reverse DNS records (i.e. PTR records whose corresponding A/AAAA record is missing).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
limitunsignedIntNoNoThe number of records to return.

Response

NameTypeRequiredNillableDescription
dnsRecordsArrayOfDNSRecordYesYesAn array of PTR records having no corresponding A/AAAA record.
totalResultsunsignedIntNoNoTotal number of records in the result set.

GetProperties

Gets properties for the specified object.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference to the object for which to get the properties.
objTypeObjectTypeNoNoThe type of the object.
onlyCustombooleanNoNoSet to true if only the custom properties for the object should be returned. Default value is false.

Response

NameTypeRequiredNillableDescription
propertiesArrayOfPropertyYesYesList of properties for the object.

GetPropertyDefinitions

Gets property definitions for the specified object type.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objTypeObjectTypeYesNoThe type of the object.

Response

NameTypeRequiredNillableDescription
propertyDefinitionsArrayOfPropertyDefinitionYesYesList of property definitions for the object.

GetRange

Gets specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoAn object reference for the IPAM range.

Response

NameTypeRequiredNillableDescription
rangeRangeYesNoThe range object.

GetRangeByIPAddress

Gets range containing specified IP address.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addrRefObjRefYesNoA reference to the IP address.

Response

NameTypeRequiredNillableDescription
rangeRangeYesNoThe range containing the specified IP address.

GetRangeStatistics

Gets range statistics.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoA reference to the range.

Response

NameTypeRequiredNillableDescription
usedstringNoNoNumber of used addresses in the address range.
freestringNoNoNumber of free addresses in the address range.
numInSubrangesstringNoNoNumber of addresses in range allocated to subranges.
percentInSubrangesstringYesNoPercent of range allocated to subranges.

GetRanges

Gets ranges.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
folderRefObjRefNoNoReference to a folder from which to get ranges.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
rangesArrayOfRangeYesYesList of ranges.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetRangesWithStatistics

Gets ranges, along with their statistics.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
calculateUtilizationbooleanYesNoDetermines whether to calculate the number of used and free addresses in the ranges.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
rangesWithStatisticsArrayOfRangeWithStatisticsYesYesList of ranges with information about used and free addresses.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetRelatedDNSRecords

Gets DNS records related to the specified DNS record (which must be either an A or AAAA record).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordRefObjRefYesNoAn object reference for the DNS address record for which to find associated records.

Response

NameTypeRequiredNillableDescription
dnsRecordsArrayOfDNSRecordYesYesAn array of records associated with the address record.

GetRole

Gets a role object based on the object reference.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRefObjRefYesNoAn object reference for the role.

Response

NameTypeRequiredNillableDescription
roleRoleYesNoThe role object.

GetRoles

Gets a list of roles.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
rolesArrayOfRoleYesYesList of roles.
totalResultsunsignedIntYesNoTotal number of records in the result set.

GetRoutersForRange

Gets routers for the specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoA reference to the range.
includeChildRangesbooleanNoNoIf set, return routers for child ranges as well.

Response

NameTypeRequiredNillableDescription
addressesArrayOfIPAddressYesYesList of router IP addresses.

GetServiceStatus

.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
serverRefObjRefYesNoAn object reference for the DNS server.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
serviceStatusServiceStatusYesNoThe service status.

GetSubranges

Gets subranges of the specified range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
parentRefObjRefYesNoA reference to the range that contains the subranges.
depthunsignedIntNoNoSpecifies how many levels of subranges should be retrieved.

Response

NameTypeRequiredNillableDescription
rangesArrayOfRangeYesYesList of subranges.

GetSystemSettings

Gets system settings.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

Response

NameTypeRequiredNillableDescription
systemSettingsArrayOfSystemSettingYesYesList of system settings.

GetUser

Gets specified user.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
userRefObjRefYesNoAn object reference for the user. Use "." to get the current user.

Response

NameTypeRequiredNillableDescription
userUserYesNoThe user object.

GetUsers

Gets users.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
filterstringNoYesFiltering criteria for the records returned.
offsetunsignedIntNoNoSpecifies the offset to use when listing the records. A value of 0 starts with the first record.
limitunsignedIntNoNoThe number of records to return.
sortBystringNoNoThe name of the field to sort by.
sortOrderSortOrderNoNoThe sort order to use.

Response

NameTypeRequiredNillableDescription
usersArrayOfUserYesYesArray of users.
totalResultsunsignedIntYesNoTotal number of records in the result set.

HasAccess

Checks whether the currently logged in user has the specified access for the specified objects.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
accessNamestringYesNoThe name of the access entry for which to check.
objRefsArrayOfObjRefYesNoReferences to the objects for which to check the access.
objTypeObjectTypeNoNoThe type of the objects for which to check for access.

Response

NameTypeRequiredNillableDescription
hasAccessEntriesArrayOfHasAccessEntryYesNoEntries specifying whether the user has access to each object.

JoinRanges

Joins the specified address ranges together into a new address range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangesArrayOfObjRefYesNoReferences to the address ranges to join.
copyAccessFromRefObjRefNoNoA reference to the address range containing the access information that should be used for the new address range.
subnetbooleanNoNoDetermines if the new address range should be defined as a subnet.
lockedbooleanNoNoDetermines if the new address range should be set as locked.
autoAssignbooleanNoNoDetermines if it should be possible to automatically assign IP addresses from the new address range.
inheritAccessbooleanNoNoDetermines if the new address range should inherit access from its parent range.
customPropertiesArrayOfPropertyNoNoThe custom properties for the new address range.
discoveryDiscoveryNoNoThe discovery (ping) schedule that should be set for the new address range.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
refObjRefYesNoReference to the resulting address range.

Login

Logs into the Men & Mice Suite through the SOAP interface.

Arguments

NameTypeRequiredNillableDescription
serverstringYesNoDNS name or IP address of the server running Men & Mice Central.
loginNamestringYesNoLogin name of user.
passwordstringYesNoUser password.
replaceControlCharactersbooleanNoNoDetermines if invalid control characters in user data should be replaced by a question mark.

Response

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID for this login.

Logout

Logs out of the Men & Mice Suite.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

MigrateDNSZone

Migrates a DNS zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoAn object reference for the DNS zone.
dnsServerRefObjRefYesNoAn object reference for the destination DNS server.
dnsViewRefObjRefNoYesAn object reference for a view on the destination DNS server.
saveCommentstringNoYesSave comment text to associate with the action.

ModifyDHCPFailoverRelationship

Modifies the specified DHCP failover relationship on the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpFailoverRelationshipDHCPFailoverRelationshipYesNoThe DHCP failover relationship to modify.
saveCommentstringNoYesSave comment text to associate with the action.

ModifyDHCPOptionDefinition

Modifies the specified DHCP option definition on the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoThe DHCP server on which the option definition should be modified.
dhcpOptionDefinitionDHCPOptionDefinitionYesNoThe DHCP option definition to modify.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope containing the DHCP policies.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).
dhcpPolicyNamestringYesNoThe DHCP policy to modify.
dhcpPolicyDHCPPolicyYesNoThe DHCP policy.
saveCommentstringNoYesSave comment text to associate with the action.

ModifyPropertyDefinition

Modifies a custom property definition.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objTypeObjectTypeYesNoThe object type to which the custom property definition is associated.
propertystringYesNoThe name of the custom property definition.
propertyDefinitionPropertyDefinitionYesNoThe modified custom property definition.
updateExistingbooleanNoNoShould objects be updated with the new value.
saveCommentstringNoYesSave comment text to associate with the action.

MoveIPAMRecord

Moves an IPAM record from one IP address to another.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
fromRefObjRefYesNoReference to the IP address from which the IPAM record should be moved.
toRefObjRefYesNoReference to the IP address to which the IPAM record should be moved.
saveCommentstringNoYesSave comment text to associate with the action.
forcebooleanNoYesIf set to true, will ignore and overwrite existing custom property values on destination IP address.

Response

NameTypeRequiredNillableDescription
errorsArrayOfErrorYesYesError 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objRefsArrayOfObjRefYesNoReferences to the objects that should be moved.
objTypeObjectTypeNoNoThe type of the objects that should be moved.
addressSpaceRefObjRefNoNoReference to the address space to which the objects should be moved.
saveCommentstringNoYesSave comment text to associate with the action.
forcebooleanNoNoA 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

NameTypeRequiredNillableDescription
errorsArrayOfObjectErrorYesYesError 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addrRefObjRefYesNoReference to the IP address to ping.

Response

NameTypeRequiredNillableDescription
alivebooleanYesNoDetermines whether the host responded to the ping request.
pingTimeunsignedIntYesNoThe response time in milliseconds.

PlaceInADSite

Places the specified address ranges in the specified AD site.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteRefObjRefYesNoReference to the AD site in which the address ranges should be placed.
rangeRefsArrayOfObjRefYesNoReferences to the address ranges that should be placed in the AD site.
locationstringNoYesLocation property to be set for AD subnet.
descriptionstringNoYesDescription property to be set for AD subnet.
saveCommentstringNoYesSave comment text to associate with the action.

PlaceInCloudNetwork

Places the specified subnets in the specified cloud network.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
cloudNetworkRefObjRefYesNoReference to the cloud network in which the subnets should be placed.
cloudSubnetsArrayOfCloudSubnetYesNoThe subnets that should be placed in the cloud network.
saveCommentstringNoYesSave comment text to associate with the action.

PlaceInFolder

Places the specified objects in the specified folder.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
folderRefObjRefYesNoReference to the folder in which the objects should be placed.
objRefsArrayOfObjRefYesNoReferences to the objects that should be placed in the folder.
saveCommentstringNoYesSave comment text to associate with the action.

PromoteDNSSlaveZone

Promotes a DNS slave zone.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsZoneRefObjRefYesNoAn object reference for the DNS slave zone.
unchangedPrimaryMasterbooleanNoNoSpecifies whether primary master field should be left unchanged.
saveCommentstringNoYesSave comment text to associate with the action.

ReconcileDHCPScope

Performs reconcile action on a specific scope or on all scopes on a specific server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference 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.
objTypeObjectTypeNoNoThe type of the object on which the reconcile action should be performed. Must be either DHCPServer or DHCPScope.
fixbooleanNoNoSet to true in order to instruct the relevant DHCP server to try and fix any entries that require reconciling.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
dhcpScopeReconcileEntriesArrayOfDHCPScopeReconcileEntryYesYes.

RejectChanges

Reject change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
changeRequestRefObjRefYesNoAn object reference for the change request.
dnsZoneChangesArrayOfDNSZoneChangeNoNoRequested DNS zone change(s).
dnsRecordChangesArrayOfDNSRecordChangeNoNoRequested DNS record change(s).
dhcpScopeChangesArrayOfDHCPScopeChangeNoNoRequested DHCP scope change(s).
dhcpReservationChangesArrayOfDHCPReservationChangeNoNoRequested DHCP reservation change(s).
dhcpExclusionChangesArrayOfDHCPExclusionChangeNoNoRequested DHCP exclusion change(s).
dhcpAddressPoolChangesArrayOfDHCPAddressPoolChangeNoNoRequested DHCP address pool change(s).
dhcpOptionChangesArrayOfDHCPOptionChangeNoNoRequested DHCP option change(s).
saveCommentstringNoYesSave comment text to associate with the action.

RejectDNSRecordChanges

Rejects DNS record change(s).

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordChangeRequestRefObjRefYesNoAn object reference for the DNS record change request.
dnsRecordChangesArrayOfDNSRecordChangeYesNoThe requested DNS record change(s).
saveCommentstringNoYesSave comment text to associate with the action.

ReleaseDHCPLease

Releases the specified DHCP lease.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpScopeRefObjRefYesNoReference to the DHCP scope from which the lease should be released.
leaseIPAddressYesNoIP address of the lease.
saveCommentstringNoYesSave comment text to associate with the action.

ReleaseDHCPLeases

Releases the specified DHCP leases.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpLeaseRefArrayOfDHCPLeaseReferenceYesNoThe DHCP leases to be released.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveDHCPFailoverRelationships

Remove a DHCP failover relationship.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
DHCPRefAndFailoverRelationshipNamesArrayOfDHCPRefAndFailoverRelationshipNamesYesNoAn array of DHCP failover relationships to remove.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveDHCPOptionDefinition

Removes the specified DHCP option definition from the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoThe DHCP server from which the option definition should be removed.
dhcpOptionDefinitionDHCPOptionDefinitionYesNoThe DHCP option definition to remove.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope containing the DHCP policy.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).
dhcpPolicyNamestringYesNoThe DHCP policy to remove.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveDHCPScopesFromDHCPFailoverRelationship

Remove DHCP scope(s) from a DHCP failover relationship.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.
dhcpFailoverRelationshipNamestringYesNoThe DHCP failover relationship.
dhcpScopeRefsArrayOfObjRefYesNoReferences to DHCP scopes that should be removed from the DHCP failover relationship.
dhcpFailoverRelationshipDeconfigureActionDHCPFailoverDeconfigureActionNoYesOptionally disable or delete DHCP scopes on partner server.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveFromADSite

Removes the specified address ranges from the specified AD site.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
adSiteRefObjRefYesNoReference to the AD site from which the address ranges should be removed.
rangeRefsArrayOfObjRefYesNoReferences to the address ranges that should be removed from the AD site.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveFromCloudNetwork

Removes the specified address ranges from their respective cloud networks.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefsArrayOfObjRefYesNoReferences to the address ranges that should be removed from cloud networks.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveFromFolder

Removes the specified objects from the specified folder.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
folderRefObjRefYesNoReference to the folder from which the objects should be removed.
objRefsArrayOfObjRefYesNoReferences to the objects that should be removed from the folder.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveObject

Removes the specified object.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference to the object that should be removed.
objTypeObjectTypeNoNoThe type of the object that should be removed.
forceRemovalbooleanNoNoIf possible, then force removal of object.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveObjects

Removes the specified objects.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objRefsArrayOfObjRefYesNoReferences for the objects that should be removed.
objTypeObjectTypeNoNoThe type of the objects that should be removed.
forceRemovalbooleanNoNoIf possible, then force removal of object.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
errorsArrayOfObjectErrorYesYesError messages. One error message is generated for each object that could not be successfully removed.

RemovePropertyDefinition

Removes the specified custom property definition.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
objTypeObjectTypeYesNoThe object type to which the custom property definition is associated.
propertystringYesNoThe name of the custom property definition.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveRoleFromGroup

Removes a role from a group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRefObjRefYesNoA reference to the role to remove.
groupRefObjRefYesNoA reference to the group from which the role should be removed.
saveCommentstringNoYesSave comment text to associate with the action.

RemoveRoleFromUser

Removes a role from a user.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
roleRefObjRefYesNoA reference to the role to remove.
userRefObjRefYesNoA reference to the user from which the role should be removed..
saveCommentstringNoYesSave comment text to associate with the action.

RemoveUserFromGroup

Removes a user from a group.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
userRefObjRefYesNoA reference to the user to remove.
groupRefObjRefYesNoA reference to the group from which the user should be removed.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoAn object reference for the DHCP server.
dhcpFailoverRelationshipNamestringNoNoDHCP failover relationship.
dhcpScopeRefObjRefNoNoAn object reference for a DHCP scope.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
identityRefObjRefYesNoObject reference for a user or group. The command only retrieves access information for the specified user or group.
identityTypeObjectTypeNoNoThe object type of the identity.
objTypesArrayOfObjectTypeYesNoList of object types for which to return access information.

Response

NameTypeRequiredNillableDescription
objectAccessArrayOfObjectAccessYesYesAccess 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
reportTypeDHCPScopeOptionsReportTypeYesNoSpecifies the report type to return.
optionunsignedIntYesNoThe option to query for.
vendorClassstringNoNoThe vendor class to use.
userClassstringNoNoThe user class to use.
valuestringNoNoThe value to query for.
filterstringNoYesFiltering criteria for the records returned.

Response

NameTypeRequiredNillableDescription
entriesArrayOfDCHPScopeOptionsReportEntryYesYesList of scopes fulfilling the search criteria.

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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
typeHostDiscoveryTypeYesNoSpecifies the report type to return.
startDateDateTimeNoNoThe start date to use.
subnetFilterstringNoYesThe subnet to use if the host list should return results for a given subnet.
limitunsignedIntNoYesThe maximum number of entries to return.

Response

NameTypeRequiredNillableDescription
entriesArrayOfHostDiscoveryReportEntryYesYesList of host entries fulfilling the search criteria.

ReportIPFromClientIdentifier

Reports on DHCP reservations and DHCP leases that are associated with the specified client identifier.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
clientIdentifierstringYesNoSpecifies the MAC address or client identifier to search for.

Response

NameTypeRequiredNillableDescription
dhcpReservationsArrayOfDHCPReservationYesYesAn array of DHCP reservations that match the client identifier.
dhcpLeasesArrayOfDHCPLeaseYesYesAn array of DHCP leases that match the client identifier.
addressesArrayOfIPAddressYesYesAn 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
srcAddressSpaceRefObjRefYesNoA reference to the source address space.
destAddressSpaceRefObjRefYesNoA reference to the destination address space.

Response

NameTypeRequiredNillableDescription
entriesArrayOfMergeAddressSpacesReportEntryYesYesList of possible conflicts.
totalResultsunsignedIntYesNoTotal number of possible conflicts.

ReportMultilabelHosts

Reports all A and AAAA records that have multiple labels in the name field.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.

Response

NameTypeRequiredNillableDescription
hostsArrayOfMultiLabelHostReportEntryYesYesList of hosts fulfilling the search criteria.

RunCommand

Runs a command and returns the output.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
namestringYesNoThe command to run.
parametersstringNoYesParameters for the command.
interpreterstringNoYesOptional interpreter.
interpreterParametersstringNoYesOptional interpreter parameters.

Response

NameTypeRequiredNillableDescription
outputstringNoYesThe output of the command.

SendMail

Sends an email message through an SMTP mail server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
smtpServerstringYesNoThe name of the SMTP mail server.
fromstringYesNoThe sender's email address.
tostringYesNoComma separated list of recipient email addresses.
ccstringNoNoComma separated list of email addresses for cc recipients.
bccstringNoNoComma separated list of email addresses for bcc recipients.
subjectstringNoNoThe subject of the email message.
bodystringYesNoThe body of the email message.

SetCurrentAddressSpace

Switches over to the specified address space.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
addressSpaceRefObjRefYesNoReference to the address space to which should be switched.

SetDHCPAddressPoolPermitList

Sets DHCP address pool permit list for the specified DHCP address pool.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpAddressPoolRefObjRefYesNoReference to the DHCP address pool for which to set the address pool permit list.
dhcpAddressPoolPermitsArrayOfDHCPAddressPoolPermitYesYesThe DHCP address pool permit list to set.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference to the object for which to set the DHCP options.
objTypeObjectTypeNoNoThe type of the object for which to set the DHCP options.
ticketunsignedIntNoYesTicket 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.
dhcpOptionsArrayOfDHCPOptionYesYesThe DHCP options to set.
saveCommentstringNoYesSave 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ownerRefObjRefYesNoA reference to the DHCP server/scope for which the DHCP policy enforcement is set.
objTypeObjectTypeNoNoThe object type of the owner (i.e. either DHCP server or DHCP scope).
enforcebooleanYesNoSpecifies whether DHCP policies should be enforced.
saveCommentstringNoYesSave comment text to associate with the action.

SetDHCPSubclasses

Sets DHCP subclasses for the specified DHCP class on the specified DHCP server.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dhcpServerRefObjRefYesNoReference to the DHCP server on which the DHCP subclasses should be set.
dhcpClassNamestringYesNoThe name of the DHCP class for which the DHCP subclasses should be set.
dhcpSubclassesArrayOfStringYesYesThe DHCP subclasses to set.
saveCommentstringNoYesSave comment text to associate with the action.

SetDNSRecordAging

Sets aging on or off for the specified record.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
dnsRecordRefObjRefYesNoAn object reference for the DNS record.
agingbooleanYesNoIf true, then aging will be enabled for the record else it will be disabled.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
dnsRecordDNSRecordYesNoThe 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
ipamRecordBeforeIPAMRecordYesNoThe IPAM record as it was before calling SetIPAMRecord.
ipamRecordAfterIPAMRecordYesNoThe IPAM record as it should be after calling SetIPAMRecord.
saveCommentstringNoYesSave comment text to associate with the action.
forceOverrideOfNamingConflictCheckbooleanNoNoSet 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

NameTypeRequiredNillableDescription
errorsArrayOfErrorYesYesError 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

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoThe range.
inheritAccessbooleanNoNoSet inheritAccess flag on or off for the range.
inheritChildAccessbooleanNoNoSet inheritAccess flag on or off for subranges of the range.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
errorsArrayOfErrorYesYesError messages.

SetObjectAccess

Sets access for the specified objects.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
identityAccessArrayOfIdentityAccessYesNoThe access to set for the objects.
objRefsArrayOfObjRefYesNoReferences to the objects for which the access should be set.
objTypeObjectTypeNoNoThe type of the objects for which the access should be set.
saveCommentstringNoYesSave comment text to associate with the action.

SetPassword

Changes the password for the currently logged in user.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
oldPasswordstringYesNoThe old password for the user.
newPasswordstringYesNoThe new password for the user.

SetProperties

Sets properties for the specified object.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
refObjRefYesNoReference to the object for which properties should be set.
objTypeObjectTypeNoNoThe type of the object for which properties should be set.
saveCommentstringNoYesSave comment text to associate with the action.
deleteUnspecifiedbooleanNoNoSet to true if properties that are not explicitly set should be cleared. Default value is false.
propertiesArrayOfPropertyYesNoThe properties and property values that should be set for the object.

SetRoutersForRange

Sets routers for the specified address range.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoReference to the address range for which the routers should be set.
addressesArrayOfIPAddressYesYesIP addresses of the routers.
recursivebooleanNoNoSpecifies whether a router address should be placed in child subnet if the address belongs to the subnet.
saveCommentstringNoYesSave comment text to associate with the action.

SetServiceStatus

.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
serverRefObjRefYesNoAn object reference for the DNS server.
serviceStatusServiceStatusYesNoThe service status.
saveCommentstringNoYesSave comment text to associate with the action.

SetSystemSettings

Sets system settings.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
systemSettingsArrayOfSystemSettingYesYesThe system settings that should be set.

SplitRange

Splits the specified address range into new subranges.

Arguments

NameTypeRequiredNillableDescription
sessionstringYesNoSession ID from the Login command.
rangeRefObjRefYesNoReference to the address range that should be split.
cidrunsignedIntYesNoDetermines the size of the resulting subranges, e.g. to split an address range into /24 subranges the value 24 would be used.
subnetbooleanNoNoDetermines if the new subranges should be defined as subnets.
lockedbooleanNoNoDetermines if the new subranges should be set as locked.
autoAssignbooleanNoNoDetermines if it should be possible to automatically assign IP addresses from the new subranges.
customPropertiesArrayOfPropertyNoNoThe custom properties for the new subranges.
discoveryDiscoveryNoNoThe discovery (ping) schedule that should be set for the new subranges.
saveCommentstringNoYesSave comment text to associate with the action.

Response

NameTypeRequiredNillableDescription
rangesArrayOfRangeYesNoThe new subranges.

  • No labels