NSService

Description	Label
Managed BIND	managed_named
FusionLayer DNS	DNS
Managed DHCP	managed_dhcpd
Managed NDS	managed_nsd
Secure64 DNS Server	managed_secure64
Secure64 DNS Server Signer	managed_s64signer
Standalone DNS	standalone_named
Legacy Bindconf	legacy
Standalone DHCP	standalone_dhcpd
FusionLayer DHCP	FusionLayer DHCP
Managed Unbound	managed_unbound
Secure64 DNS Cache	managed_s64cache
Managed Unbound	managed_unbound
Nominum ANSP	NominumANSP
Nominum ANS	NominumANS
Nominum DCS	NominumDCS
Nominum Vantio	NominumVantio
Microsoft DHCP	MSDHCP

Methods

addBlock ( string keyname , string digest , string address , number bitmask , string family , string owner , string blocktype , boolean subnet )

Add a new block to IPAM

Parameters
- keyname: string
  
  API key name used
- digest: string
  
  Digest calculated from location, address, bitmask, family, owner and block type
- address: string
  
  Prefix (address) of the new block
- bitmask: number
  
  Bitmask of the new block
- family: string
  
  Address family (IPv4/IPv6)
- owner: string
  
  Owner of the block
- blocktype: string
  
  Type of new block (normal, address_set, delegated)
- subnet: boolean [ default: False ]
  
  Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block.
Return value

boolean
Return true if adding succeeded, otherwise false
addDNSRecord ( string keyname , string digest , string zonename , string viewname , DNSNode record )

Add a DNS record, creating the node if missing
When adding NS record, leave the name field of record empty unless you want to add delegation.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename, viewname, record.name, record.type, record.ttl and record.data
- zonename: string
  
  Add record into this zone
- viewname: string
  
  Add record into zone in this view, leave empty to add into Default view
- record: DNSNode
  
  DNSNode object populated with data
Return value

boolean
Returns true if DNSNode was successfully added, otherwise raises APIFault with error message
addHost ( string keyname , string digest , IPAMBlock location , string address , string owner , string dnsname , string view , [ IPAMInfo ] infos , boolean force )

Add a host to IPAM

Parameters
- keyname: string
  
  API Key name
- digest: string
  
  Calculated from address, dnsname and view
- location: IPAMBlock
  
  IPAMBlock representing the location to add new host into
- address: string
  
  Address of the new host
- owner: string [ default: "" ]
  
  Optional owner. Uses owner of the location if left empty
- dnsname: string [ default: "" ]
  
  Optional DNS name
- view: string [ default: "" ]
  
  Optional DNS view
- infos: [ IPAMInfo ] [ default: [] ]
  
  List of IPAMInfo elements that will be added to host
- force: boolean [ default: False ]
  
  Ignore possible warnings
Return value

IPAMHost
Returns the new created host as IPAMHost
addZone ( string keyname , string digest , string zonename , string soa , [ string ] nameservers , string viewname , boolean isprimary , [ MasterNS ] masters , boolean forward_updates )

Add a new zone. If clustername is specified the zonetype parameter can be left empty.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename and viewname
- zonename: string
  
  Zone to create
- soa: string
  
  Zone SOA record in full
- nameservers: [ string ] [ default: [] ]
  
  List of name servers to add to zone
- viewname: string [ default: "" ]
  
  Optional view name
- isprimary: boolean [ default: True ]
  
  Normally creates primary zones. Set to False to create a secondary zone.
- masters: [ MasterNS ] [ default: [] ]
  
  (secondary only) Master servers of a secondary zone, list of MasterNS)
- forward_updates: boolean [ default: True ]
  
  (secondary only) Set to False to disable DDNS updates of the zone to masters.
Return value

boolean
Return true if zone was successfully added
clearBlock ( string keyname , string digest , string address , number bitmask , string owner , boolean force )

Clear the specified block from IPAM Deletes block contents but leaves the block

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from address and bitmask
- address: string
  
  Address of the block to be deleted
- bitmask: number
  
  Bitmask of the block to be deleted
- owner: string [ default: "" ]
  
  Block owner
- force: boolean [ default: True ]
  
  Ignore possible warnings and clear
Return value

boolean
None
countBlocks ( string keyname , string digest , string location , number bitmask , boolean recurse , string owner )

Count number of blocks in a given location

Parameters
- keyname: string
  
  API key
- digest: string
  
  Digest calculated from location
- location: string
  
  Network address to start calculating from
- bitmask: number [ default: -1 ]
  
  None
- recurse: boolean [ default: False ]
  
  Count recursively all sub blocks
- owner: string [ default: "" ]
  
  Count only blocks owned by owner. Leave empty to count all blocks. (Optional)
Return value

number
Returns the number of blocks
deleteBlock ( string keyname , string digest , string address , number bitmask , string owner , boolean force )

Remove the specified block from IPAM

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from address and bitmask
- address: string
  
  Address of the block to be deleted
- bitmask: number
  
  Bitmask of the block to be deleted
- owner: string [ default: "" ]
  
  Block owner
- force: boolean [ default: False ]
  
  Delete block even if not empty
Return value

boolean
None
deleteDNSHost ( string keyname , string digest , string hostname , string zonename , string viewname , boolean delete_reverse )

Delete specified host

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Message digest calculated from hostname, zonename and viewname
- hostname: string
  
  Hostname to be deleted (may contain zone name)
- zonename: string
  
  Zone to delete host from
- viewname: string
  
  View where said zone is in
- delete_reverse: boolean [ default: True ]
  
  Delete matching PTR records (default: True)
Return value

boolean
Returns true if successfully deleted, otherwise returns false
deleteHost ( string keyname , string digest , IPAMHost host , string delete_forward , boolean delete_reverse , [ string ] views )

Delete specified host

Parameters
- keyname: string
  
  API Key name
- digest: string
  
  Message digest calculated from host address and host owner (see param host)
- host: IPAMHost
  
  IPAMHost representing host to be deleted
- delete_forward: string [ default: "host" ]
  
  [no|host|hostdata], "host" = Delete DNS hosts (A/AAAA records pointing to host IP), "hostdata" = Delete also hosts' DNS nodes (incl. any contained records)
- delete_reverse: boolean [ default: True ]
  
  Delete reverse DNS PTR records which point to the matching A/AAAA records
- views: [ string ] [ default: [] ]
  
  DNS views that DNS deletes will be limited to
Return value

boolean
Returns True/False
deleteZone ( string keyname , string digest , string zonename , string viewname )

Remove zone from NameSurfer

Parameters
- keyname: string
  
  API Key name
- digest: string
  
  Message digest calculated using zonename and viewname
- zonename: string
  
  Zone name to remove
- viewname: string [ default: "" ]
  
  Optional view name
Return value

boolean
Returns True if zone was successfully removed
fetchBlock ( string keyname , string digest , string address , number bitmask , string owner )

Fetch a given block

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from address and bitmask
- address: string
  
  Address of the block to be fetched
- bitmask: number
  
  Bitmask of the block to be fetched
- owner: string [ default: "" ]
  
  Optional owner to differentiate between blocks
Return value

IPAMBlock
Returns an IPAMBlock
fetchZone ( string keyname , string digest , string zonename , string viewname )

Fetch information for the given zone

Parameters
- keyname: string
  
  API Key name
- digest: string
  
  Message digest calculated using zonename and viewname
- zonename: string
  
  Zone name to fetch
- viewname: string [ default: "" ]
  
  Optional view name
Return value

DNSZone
Return a DNSZone
listBlocks ( string keyname , string digest , string location , number offset , number limit , boolean recurse , string owner )

Fetch list of IPAM blocks inside location.
NOTE : Result list DOES NOT include block given as starting point in location.

Parameters
- keyname: string
  
  API key
- digest: string
  
  Digest calculated from location
- location: string
  
  Starting point to list blocks from. Leave empty to list from top level.
- offset: number [ default: 0 ]
  
  Number of blocks to omit from beginning of list. If recurse=true, must be 0 or omitted.
- limit: number [ default: -1 ]
  
  If recurse=false (default), maximum number of blocks to return. If recurse=true, maximum tree depth to return.
- recurse: boolean [ default: False ]
  
  Also return child blocks, if limit > 0. Disables "offset" parameter.
- owner: string [ default: "" ]
  
  List blocks owned by owner
Return value

[ IPAMBlock ]
Return a list of IPAMBlocks
listBlocksByInfos ( string keyname , string digest , [ IPAMInfo ] infos , string owner )

Search IPAM blocks by given info fields. Returns a list of IPAMBlock objects. Only blocks that have free IP addresses will be returned.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from info names and values
- infos: [ IPAMInfo ]
  
  A list of IPAMInfo DTOs
- owner: string [ default: "" ]
  
  Optional owner
Return value

[ IPAMBlock ]
Returns a list of IPAMBlock objects. Only blocks that have free IP addresses will be returned.
listHosts ( string keyname , string digest , IPAMBlock location , boolean recurse )

List hosts under a given location

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Message digest calculated from location.network and location.bitmask
- location: IPAMBlock
  
  IPAMBlock representation of the location, set location.network to 0.0.0.0 to list from RootBlocks
- recurse: boolean [ default: False ]
  
  Whether to recurse into blocks below location
Return value

[ IPAMHost ]
List of IPAMHosts found
listRemoteClusters ( string keyname , string digest , string filter , number count , number offset , string sort_by , string sort_dir )

List server clusters API key keyname has access to.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from keyname and secret key value
- filter: string [ default: "" ]
  
  Reserved for future improvements
- count: number [ default: -1 ]
  
  Number of clusters to return
- offset: number [ default: 0 ]
  
  Number of clusters to skip
- sort_by: string [ default: "" ]
  
  Reserved for future improvements
- sort_dir: string [ default: "" ]
  
  Reserved for future improvements
Return value

[ RemoteClusterDTO ]
List of cluster objects
listRemoteServers ( string keyname , string digest , string filter , number count , number offset , string sort_by , string sort_dir )

List remote servers API key keyname has access to.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from keyname and secret key value
- filter: string [ default: "" ]
  
  Reserved for future improvements
- count: number [ default: -1 ]
  
  Number of servers to return
- offset: number [ default: 0 ]
  
  Number of servers to skip
- sort_by: string [ default: "" ]
  
  Reserved for future improvements
- sort_dir: string [ default: "" ]
  
  Reserved for future improvements
Return value

[ RemoteServerEntry ]
List of server objects
listZones ( string keyname , string digest , string mode )

List all zones or zones of specified type

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from keyname and secret key value
- mode: string [ default: "forward" ]
  
  Select whether to list forward, reverse or all zones (accepts forward / reverse / all)
Return value

[ DNSZone ]
Returns a list of DNSZone objects
remoteAddZone ( string keyname , string digest , string zonename , string zonetype , string viewname , string servername , string servertype , string clustername , [ KVParameter ] parameters )

Add zone to remote server or server cluster. Zone can be added either to a single server or to a server cluster.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename, viewname and either server name or cluster name
- zonename: string
  
  Zone to create
- zonetype: string [ default: "" ]
  
  Zone type (master / slave / etc.)
- viewname: string [ default: "" ]
  
  Viewname (optional)
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
- parameters: [ KVParameter ] [ default: [] ]
  
  Optional list of key/value pairs. Reserved for future use.
Return value

boolean
True if successfully added
remoteDeleteZone ( string keyname , string digest , string zonename , string viewname , string servername , string servertype , string clustername )

Delete zone from remote server or server cluster. Zone can be removed either from a single server or from a server cluster.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename, viewname and either server name or cluster name
- zonename: string
  
  Zone to delete
- viewname: string [ default: "" ]
  
  Viewname (optional)
- servername: string [ default: "" ]
  
  Server name, where the zone is removed from
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is removed from
Return value

boolean
True if successfully removed
remoteListViews ( string keyname , string digest , string filter , string servername , string servertype , string clustername , number count , number offset , string sort_by , string sort_dir )

List views from remote server or server cluster

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from either servername or clustername
- filter: string [ default: "" ]
  
  Reserved for future improvements
- servername: string [ default: "" ]
  
  Server name where the operation is done
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Cluster name where the operation is done
- count: number [ default: -1 ]
  
  Number of views to return
- offset: number [ default: 0 ]
  
  Number of views to skip
- sort_by: string [ default: "" ]
  
  Reserved for future improvements
- sort_dir: string [ default: "" ]
  
  Reserved for future improvements
Return value

[ MinimalView ]
Returns a list of view names
remoteListZones ( string keyname , string digest , string filter , string servername , string servertype , string clustername , number count , number offset , string sort_by , string sort_dir )

List zones from remote server or server cluster

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from either servername or clustername
- filter: string [ default: "" ]
  
  Reserved for future improvements
- servername: string [ default: "" ]
  
  Server name where the operation is done
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Cluster name where the operation is done
- count: number [ default: -1 ]
  
  Number of servers to return
- offset: number [ default: 0 ]
  
  Number of servers to skip
- sort_by: string [ default: "" ]
  
  Reserved for future improvements
- sort_dir: string [ default: "" ]
  
  Reserved for future improvements
Return value

[ MinimalZone ]
Returns a list of MinimalZone objects
remoteServerCheckConfiguration ( string keyname , string digest , string servername , string servertype , string clustername )

Check remote server configuration syntax.

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

[ RemoteServerConfiguration ]
True if successfully started
remoteServerExportConfiguration ( string keyname , string digest , string servername , string servertype , string clustername )

Export remote server configuration.

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

[ RemoteServerConfiguration ]
True if successfully started
remoteServerRestart ( string keyname , string digest , string servername , string servertype , string clustername )

Restart remote server

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

boolean
True if successfully started
remoteServerStart ( string keyname , string digest , string servername , string servertype , string clustername )

Start remote server

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

boolean
True if successfully started
remoteServerStop ( string keyname , string digest , string servername , string servertype , string clustername )

Stop remote server

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

boolean
True if successfully started
remoteServerUploadConfiguration ( string keyname , string digest , string servername , string servertype , string clustername )

Upload configuration from NameSurfer's database to remote server

Parameters
- keyname: string
  
  None
- digest: string
  
  None
- servername: string [ default: "" ]
  
  Server name, where the zone is added to
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server.
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is added to
Return value

[ RemoteServerConfiguration ]
True if successfully started
remoteSignZone ( string keyname , string digest , string zonename , string viewname , string when , string servername , string servertype , string clustername )

Sign zone zonename on remote server or server cluster.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from servername or clustername
- zonename: string
  
  Name of the zone
- viewname: string
  
  Name of the view
- when: string [ default: "" ]
  
  Time at which the specified operation should take effect. RESERVED FOR FUTURE USE. NOT SUPPORTED AT THE MOMENT.
- servername: string [ default: "" ]
  
  Server name where the operation is done
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Cluster name where the operation is done
Return value

boolean
None
remoteUnSignZone ( string keyname , string digest , string zonename , string viewname , string when , string servername , string servertype , string clustername )

Unsign zone zonename on remote server or server cluster.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename, viewname and servername or clustername
- zonename: string
  
  Name of the zone
- viewname: string
  
  Name of the view
- when: string [ default: "" ]
  
  Time at which the specified operation should take effect
- servername: string [ default: "" ]
  
  Server name where the operation is done RESERVED FOR FUTURE USE. NOT SUPPORTED AT THE MOMENT.
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Cluster name where the operation is done
Return value

boolean
None
remoteUpdateZone ( string keyname , string digest , string zonename , string viewname , string servername , string servertype , string clustername , [ KVParameter ] parameters )

Update zone to remote server or server cluster. Zone can be updated either to a single server or to a server cluster. This is selected by sending either servername or clustername (not both).

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename, viewname and either server name or cluster name
- zonename: string
  
  Zone to delete
- viewname: string [ default: "" ]
  
  Viewname (optional)
- servername: string [ default: "" ]
  
  Server name, where the zone is removed from
- servertype: string [ default: "" ]
  
  Used to differentiate between different server types running on same server
- clustername: string [ default: "" ]
  
  Server cluster, where the zone is removed from
- parameters: [ KVParameter ] [ default: [] ]
  
  Optional list of key/value pairs. Reserved for future use.
Return value

boolean
True if successfully removed
reserveBlockWithInfos ( string keyname , string digest , string owner , number bitmask , string blocktype , string subnet , [ IPAMInfo ] infos )

Reserve the first available block with bitmask bitmask from location that matches infos

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from info names and values
- owner: string
  
  Owner of the block (Optional)
- bitmask: number
  
  Bitmask for the new, reserved block
- blocktype: string
  
  Type of new block (normal, address_set, delegated)
- subnet: string
  
  Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block.
- infos: [ IPAMInfo ] [ default: [] ]
  
  Array of IPAMInfos that are used to find a location for the new block
Return value

IPAMBlock
None
reserveBlockWithLocation ( string keyname , string digest , IPAMBlock location , number bitmask , string blocktype , boolean subnet )

Reserve the first available block with bitmask bitmask from the given location

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from location network address, bitmask and owner
- location: IPAMBlock
  
  Block where to reserve from
- bitmask: number
  
  Bitmask for the new, reserved block
- blocktype: string
  
  Type of new block (normal, address_set, delegated)
- subnet: boolean
  
  Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block.
Return value

IPAMBlock
None
reserveIpByInfos ( string keyname , string digest , [ IPAMInfo ] infos , string owner , boolean auto_hostname , boolean add_dns )

Search IPAM blocks by given info fields and reserve a free address from a matching block if found. Adds IPs to IPAM database and generates a DNS hostname using pre-defined hostname/domain pattern. Return free address as an IPAMHostWithBlock object.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from info names and values
- infos: [ IPAMInfo ]
  
  A list of IPAMInfo DTOs
- owner: string [ default: "" ]
  
  Optional owner
- auto_hostname: boolean [ default: True ]
  
  Autogenerate hostname using default zone and host pattern for the block
- add_dns: boolean [ default: False ]
  
  Select whether to add new host to dns
Return value

IPAMHostWithBlock
Returns the newly created IPAMHostWithBlock. If auto_hostname is true, generated hostname is provided in the infos as "Hostname".
reserveIpBySubnet ( string keyname , string digest , string prefix , number bitmask , string owner , boolean auto_hostname , boolean add_dns )

Search for an IPAM block by given owner, prefix and bitmask and reserve a free address from a matching block if found. Adds IPs to IPAM database and generates a DNS hostname using pre-defined hostname/domain pattern. Return free address as an IPAMHostWithBlock object.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from prefix and bitmask
- prefix: string
  
  Subnet prefix
- bitmask: number
  
  Subnet bitmask
- owner: string [ default: "" ]
  
  IPAM Owner
- auto_hostname: boolean [ default: True ]
  
  Autogenerate hostname using default zone and host pattern for the block
- add_dns: boolean [ default: False ]
  
  Select whether to add new host to dns
Return value

IPAMHostWithBlock
Returns the newly created IPAMHostWithBlock. If auto_hostname is true, generated hostname is provided in the infos as "Hostname".
reserveMultipleIpsByInfos ( string keyname , string digest , [ IPAMInfo ] infos , string owner , boolean auto_hostname , boolean add_dns , number amount )

Search IPAM blocks by given info fields and reserve a specified number of free address from a matching block if found. Adds IPs to IPAM database and generates a DNS hostname using pre-defined hostname/domain pattern. Return free addresses as a list of IPAMHostWithBlock objects.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from info names and values
- infos: [ IPAMInfo ]
  
  A list of IPAMInfo DTOs
- owner: string [ default: "" ]
  
  Optional owner
- auto_hostname: boolean [ default: True ]
  
  Autogenerate hostname using default zone and host pattern for the block
- add_dns: boolean [ default: False ]
  
  Select whether to add new host to dns
- amount: number [ default: 1 ]
  
  Number of IPs to reserve, default is one (1)
Return value

[ IPAMHostWithBlock ]
Returns a list of newly created IPAMHostWithBlocks. If auto_hostname is true, generated hostname is provided in the infos as "Hostname".
reserveMultipleIpsBySubnet ( string keyname , string digest , string prefix , number bitmask , string owner , boolean auto_hostname , boolean add_dns , number count )

Search for an IPAM block by given owner, prefix and bitmask and reserve multiple free addresses from a matching block if found. Adds IPs to IPAM database and generates a DNS hostname using pre-defined hostname/domain pattern. Returns reserved addresses as a list of IPAMHostWithBlock objects.

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from prefix and bitmask
- prefix: string
  
  Subnet prefix
- bitmask: number
  
  Subnet bitmask
- owner: string [ default: "" ]
  
  IPAM Owner
- auto_hostname: boolean [ default: True ]
  
  Autogenerate hostname using default zone and host pattern for the block
- add_dns: boolean [ default: False ]
  
  Select whether to add new host to dns
- count: number [ default: 1 ]
  
  None
Return value

[ IPAMHostWithBlock ]
Returns the newly created IPAMHostWithBlocks. If auto_hostname is true, generated hostname is provided in the infos as "Hostname".
searchBlocks ( string keyname , string digest , string prefix , number bitmask , string owner , string infokey , string infovalue , boolean ignorecase , number count , number offset )

Search blocks with zero or more conditions. Empty (default) values means "match anything"

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from prefix, bitmask, owner, infokey and infofield
- prefix: string [ default: "" ]
  
  Search blocks that match prefix, wildcard can be used at the end of prefix
- bitmask: number [ default: 0 ]
  
  Match specific bitmask
- owner: string [ default: "" ]
  
  Match owner, wildcard can be used as a part of owner
- infokey: string [ default: "" ]
  
  Match infofield name, wildcard can be used as part of infokey
- infovalue: string [ default: "" ]
  
  Match infofield value, wildcard can be used as part of infovalue
- ignorecase: boolean [ default: False ]
  
  Perform case insensitive search when set to True
- count: number [ default: -1 ]
  
  Maximum number of results to return
- offset: number [ default: 0 ]
  
  Skip first offset results
Return value

[ IPAMBlock ]
List of IPAMBlocks matching search criteria
searchDNSChanges ( string keyname , string digest , string zone_pattern , string view_pattern , string name_pattern , string data_pattern , string rr_type , string user_pattern , string date_from , string date_to , number offset , number limit )

Search DNS changelog. Patterns may have asterisk (*) wildcard at beginning and/or end. Dates are UTC, format: {YYYY}-{MM}-{DD}T{HH}:{MM}:{SS} (all numeric, without braces).

Parameters
- keyname: string
  
  API key name
- digest: string
  
  None
- zone_pattern: string [ default: "" ]
  
  If specified, zone names must match this pattern
- view_pattern: string [ default: "" ]
  
  If specified, view names must match this pattern
- name_pattern: string [ default: "" ]
  
  If specified, node names must match this pattern
- data_pattern: string [ default: "" ]
  
  If specified, value data must match this pattern
- rr_type: string [ default: "" ]
  
  If specified, changes must contain a value of this RR type
- user_pattern: string [ default: "" ]
  
  If specified, logged user names must match this pattern
- date_from: string [ default: "" ]
  
  If specified, omit changes earlier than this (defaults to previous day at 00:00:00)
- date_to: string [ default: "" ]
  
  If this and date_from are specified, omit changes newer than this
- offset: number [ default: 0 ]
  
  Number of changes to skip from beginning, default 0
- limit: number [ default: 100 ]
  
  Maximum number of changes to return, default 100 (set to -1 to disable limit)
Return value

[ DNSChange ]
List of matching DNSChange objects.
searchDNSHosts ( string keyname , string digest , string hostpattern )

Search DNS hosts matching host pattern

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Message digest calculated from hostpattern
- hostpattern: string [ default: "" ]
  
  Search hosts matching this pattern
Return value

[ DNSNode ]
List of DNSNode objects found
searchHosts ( string keyname , string digest , string address , number bitmask , string owner , string infokey , string infovalue , boolean ignorecase , number count , number offset )

Search hosts with zero or more conditions. Empty (default) values means "match anything"

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from address, owner, infokey and infofield
- address: string [ default: "" ]
  
  Search hosts that match address wildcard can be used at the end of prefix
- bitmask: number [ default: 0 ]
  
  Match specific bitmask
- owner: string [ default: "" ]
  
  Match owner, wildcard can be used as a part of owner
- infokey: string [ default: "" ]
  
  Match infofield name, wildcard can be used as part of infokey
- infovalue: string [ default: "" ]
  
  Match infofield value, wildcard can be used as part of infovalue
- ignorecase: boolean [ default: True ]
  
  Perform case insensitive search when set to True
- count: number [ default: -1 ]
  
  Maximum number of results to return
- offset: number [ default: 0 ]
  
  Skip first offset results
Return value

[ IPAMHost ]
List of IPAMHosts matching search criteria
searchZones ( string keyname , string digest , string zonepattern )

Search zones matching zone pattern

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonepattern
- zonepattern: string [ default: "" ]
  
  Search zones matching this pattern
Return value

[ DNSZone ]
List of DNSZone objects found
updateBlock ( string keyname , string digest , string address , number bitmask , string owner , string newowner , string newtype )

Update owner or type of given IPAM block

Parameters
- keyname: string
  
  API key name used
- digest: string
  
  Digest calculated from address, bitmask, owner, newowner and newtype
- address: string
  
  Address of the block to be updated
- bitmask: number
  
  Bitmask of the block to be updated
- owner: string [ default: "" ]
  
  Original owner of the block
- newowner: string [ default: "" ]
  
  New owner of the block
- newtype: string [ default: "" ]
  
  New type of the block
Return value

boolean
Return true if successfully updated, otherwise false
updateBlockInfo ( string keyname , string digest , string address , number bitmask , string owner , [ IPAMInfo ] infos )

Update info field(s) for a given block

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Digest calculated from address, bitmask and owner
- address: string
  
  Address of the updated block
- bitmask: number
  
  Bitmask of the updated block
- owner: string [ default: "" ]
  
  Owner of the updated block
- infos: [ IPAMInfo ] [ default: [] ]
  
  List of IPAMInfo objects to set
Return value

boolean
Return true if update succeeds, otherwise return false
updateDNSHost ( string keyname , string digest , string zonename , string viewname , DNSNode oldvalue , DNSNode newvalue )

Update DNS host information Leave name property of newvalue empty to just remove oldvalue

Parameters
- keyname: string
  
  API key name
- digest: string
  
  Calculated from zonename and viewname
- zonename: string
  
  Zone where to the updates host is in
- viewname: string
  
  View name where said zone is (leave empty to use Default view)
- oldvalue: DNSNode
  
  DNSNode object specifying original values
- newvalue: DNSNode
  
  DNSNode object specifying updated values
Return value

boolean
Returns true if update succeeds, otherwise raises APIFault with an error message
updateHost ( string keyname , string digest , IPAMHost host , string new_owner , [ IPAMInfo ] infos , boolean force )

Updates specified host

Parameters
- keyname: string
  
  API Key name
- digest: string
  
  Message digest calculated with host address and host owner (see param host)
- host: IPAMHost
  
  IPAMHost representing host to be updated
- new_owner: string [ default: "" ]
  
  Change the owner of the host by setting this
- infos: [ IPAMInfo ] [ default: [] ]
  
  List of IPAMInfos to add/modify
- force: boolean [ default: False ]
  
  Whether to ignore possible warnings
Return value

boolean
Returns True/False

Types

IPAMInfo

Attributes
- name: string
  
  Info field name
- value: string
  
  Info field contents
IPAMBlock

Attributes
- network: string
  
  Network address of the block
- family: string
  
  Address family of the block (IPv4/IPv6)
- bitmask: number
  
  Bitmask of the block (e.g. 24)
- owner: string
  
  Owner of this block
- infofields: [ IPAMInfo ]
- type: string
  
  IPAM type of the block (address/divisible)
- children: [ IPAMBlock ]
DNSName

Attributes
- name: string
  
  DNS name
- view: string
  
  DNS view
IPAMHost

Attributes
- owner: string
  
  Owner of the address
- infofields: [ IPAMInfo ]
- dnsnames: [ DNSName ]
- hosttype: string
  
  Host type (IPAM/DNS)
- address: string
  
  Host address
DNSNode

Attributes
- type: string
  
  Node type
- data: string
  
  Node data
- name: string
  
  Node name
- ttl: number
  
  TTL for node
DNSZone

Attributes
- SOA: string
  
  SOA record for zone
- name: string
  
  Zone name
- dnssec: string
  
  Is DNSSEC enabled for the zone
- records: [ DNSNode ]
- serial: number
  
  Zone serial number
- view: string
  
  View zone is in
MasterNS

Attributes
- tsig_keyname: string
  
  TSIG key name to use for updates
- send_updates: boolean
  
  Send DynDNS updates to this server
- enable_ixfr: boolean
  
  Enable IXFR transfers (instead of AXFR only)
- port: number
  
  IP port server listens on
- address: string
  
  IP address server listens on
IPAMHostWithBlock

Attributes
- parent: IPAMBlock
  
  Parent IPAMBlock
- dnsnames: [ DNSName ]
- hosttype: string
  
  Host type (IPAM/DNS)
- address: string
  
  Host address
- owner: string
  
  Owner of the address
- infofields: [ IPAMInfo ]
DNSChangeValue

Attributes
- rr_type: string
  
  DNS record type
- kind: string
  
  Value change type (add/delete)
- data: string
  
  Data
- name: string
  
  DNS node name
- ttl: number
  
  Time To Live
DNSChange

Attributes
- comment: string
  
  Comment text
- username: string
  
  User name
- zone: string
  
  DNS zone name
- timestamp: string
  
  Timestamp
- data_values: [ DNSChangeValue ]
- action: string
  
  Change event type
- serial: number
  
  Zone serial
- view: string
  
  DNS view name
RemoteServerEntry

Attributes
- cluster: string
  
  Cluster
- servertype: string
  
  Server type
- role: string
  
  Role
- description: string
  
  Server description
- name: string
  
  Server name
RemoteServerConfiguration

Attributes
- configuration: string
  
  Configuration
- server: RemoteServerEntry
KVParameter

Attributes
- name: string
  
  Key name
- value: string
  
  Key value
MinimalZone

Attributes
- type: string
  
  Zone type
- name: string
  
  Zone name
- view: string
  
  View zone is in
RemoteClusterDTO

Attributes
- servers: [ RemoteServerEntry ]
- description: string
  
  Cluster description
- name: string
  
  Cluster name
MinimalView

Attributes
- name: string
  
  View name

Notes on remote server related API methods

Server types

Calculating message digests

Example

Python example code using suds library