{"version": "1.1", "url": "http://95.128.3.201:8053/API/NSService_10/jsonwsp", "servicename": "NSService_10", "type": "jsonwsp/description", "types": {"MinimalZone": {"type": {"doc": ["Zone type"], "type": "string"}, "name": {"doc": ["Zone name"], "type": "string"}, "view": {"doc": ["View zone is in"], "type": "string"}}, "DNSChange": {"comment": {"doc": ["Comment text"], "type": "string"}, "username": {"doc": ["User name"], "type": "string"}, "zone": {"doc": ["DNS zone name"], "type": "string"}, "timestamp": {"doc": ["Timestamp"], "type": "string"}, "data_values": {"type": ["DNSChangeValue"]}, "action": {"doc": ["Change event type"], "type": "string"}, "serial": {"doc": ["Zone serial"], "type": "number"}, "view": {"doc": ["DNS view name"], "type": "string"}}, "IPAMHost": {"owner": {"doc": ["Owner of the address"], "type": "string"}, "infofields": {"type": ["IPAMInfo"]}, "dnsnames": {"type": ["DNSName"]}, "hosttype": {"doc": ["Host type (IPAM/DNS)"], "type": "string"}, "address": {"doc": ["Host address"], "type": "string"}}, "RemoteServerConfiguration": {"configuration": {"doc": ["Configuration"], "type": "string"}, "server": {"type": "RemoteServerEntry"}}, "MinimalView": {"name": {"doc": ["View name"], "type": "string"}}, "DNSZone": {"SOA": {"doc": ["SOA record for zone"], "type": "string"}, "name": {"doc": ["Zone name"], "type": "string"}, "dnssec": {"doc": ["Is DNSSEC enabled for the zone"], "type": "string"}, "records": {"type": ["DNSNode"]}, "serial": {"doc": ["Zone serial number"], "type": "number"}, "view": {"doc": ["View zone is in"], "type": "string"}}, "RemoteClusterDTO": {"servers": {"type": ["RemoteServerEntry"]}, "description": {"doc": ["Cluster description"], "type": "string"}, "name": {"doc": ["Cluster name"], "type": "string"}}, "MasterNS": {"tsig_keyname": {"doc": ["TSIG key name to use for updates"], "type": "string"}, "send_updates": {"doc": ["Send DynDNS updates to this server"], "type": "boolean"}, "enable_ixfr": {"doc": ["Enable IXFR transfers (instead of AXFR only)"], "type": "boolean"}, "port": {"doc": ["IP port server listens on"], "type": "number"}, "address": {"doc": ["IP address server listens on"], "type": "string"}}, "IPAMBlock": {"network": {"doc": ["Network address of the block"], "type": "string"}, "family": {"doc": ["Address family of the block (IPv4/IPv6)"], "type": "string"}, "bitmask": {"doc": ["Bitmask of the block (e.g. 24)"], "type": "number"}, "owner": {"doc": ["Owner of this block"], "type": "string"}, "infofields": {"type": ["IPAMInfo"]}, "type": {"doc": ["IPAM type of the block (address/divisible)"], "type": "string"}, "children": {"type": ["IPAMBlock"]}}, "DNSNode": {"type": {"doc": ["Node type"], "type": "string"}, "data": {"doc": ["Node data"], "type": "string"}, "name": {"doc": ["Node name"], "type": "string"}, "ttl": {"doc": ["TTL for node"], "type": "number"}}, "DNSName": {"name": {"doc": ["DNS name"], "type": "string"}, "view": {"doc": ["DNS view"], "type": "string"}}, "RemoteServerEntry": {"cluster": {"doc": ["Cluster"], "type": "string"}, "servertype": {"doc": ["Server type"], "type": "string"}, "role": {"doc": ["Role"], "type": "string"}, "description": {"doc": ["Server description"], "type": "string"}, "name": {"doc": ["Server name"], "type": "string"}}, "DNSChangeValue": {"rr_type": {"doc": ["DNS record type"], "type": "string"}, "kind": {"doc": ["Value change type (add/delete)"], "type": "string"}, "data": {"doc": ["Data"], "type": "string"}, "name": {"doc": ["DNS node name"], "type": "string"}, "ttl": {"doc": ["Time To Live"], "type": "number"}}, "IPAMHostWithBlock": {"parent": {"doc": ["Parent IPAMBlock"], "type": "IPAMBlock"}, "dnsnames": {"type": ["DNSName"]}, "hosttype": {"doc": ["Host type (IPAM/DNS)"], "type": "string"}, "address": {"doc": ["Host address"], "type": "string"}, "owner": {"doc": ["Owner of the address"], "type": "string"}, "infofields": {"type": ["IPAMInfo"]}}, "IPAMInfo": {"name": {"doc": ["Info field name"], "type": "string"}, "value": {"doc": ["Info field contents"], "type": "string"}}, "KVParameter": {"name": {"doc": ["Key name"], "type": "string"}, "value": {"doc": ["Key value"], "type": "string"}}}, "methods": {"remoteAddZone": {"ret_info": {"doc_lines": ["True if successfully added"], "type": "boolean"}, "doc_lines": ["Add zone to remote server or server cluster.", "", "Zone can be added either to a single server or to a server cluster.", ""], "params": {"parameters": {"default": [], "def_order": 9, "doc_lines": ["Optional list of key/value pairs. Reserved for future use."], "type": ["KVParameter"], "optional": true}, "viewname": {"default": "", "def_order": 5, "doc_lines": ["Viewname (optional)"], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 8, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 6, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 7, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "zonetype": {"default": "", "def_order": 4, "doc_lines": ["Zone type (master / slave / etc.)"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename, viewname and either server name or cluster name"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone to create"], "type": "string", "optional": false}}}, "remoteServerStart": {"ret_info": {"doc_lines": ["True if successfully started"], "type": "boolean"}, "doc_lines": ["Start remote server"], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "updateDNSHost": {"ret_info": {"doc_lines": ["Returns true if update succeeds, otherwise raises APIFault with an error message"], "type": "boolean"}, "doc_lines": ["Update DNS host information", "Leave <i>name</i> property of <i>newvalue</i> empty to just remove <i>oldvalue</i>", ""], "params": {"viewname": {"def_order": 4, "doc_lines": ["View name where said zone is (leave empty to use Default view)"], "type": "string", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "oldvalue": {"def_order": 5, "doc_lines": ["DNSNode object specifying original values"], "type": "DNSNode", "optional": false}, "newvalue": {"def_order": 6, "doc_lines": ["DNSNode object specifying updated values"], "type": "DNSNode", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename and viewname"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone where to the updates host is in"], "type": "string", "optional": false}}}, "remoteServerCheckConfiguration": {"ret_info": {"doc_lines": ["True if successfully started"], "type": ["RemoteServerConfiguration"]}, "doc_lines": ["Check remote server configuration syntax."], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "listRemoteServers": {"ret_info": {"doc_lines": ["List of server objects"], "type": ["RemoteServerEntry"]}, "doc_lines": ["List remote servers API key <i>keyname</i> has access to.", ""], "params": {"count": {"default": -1, "def_order": 4, "doc_lines": ["Number of servers to return"], "type": "number", "optional": true}, "sort_dir": {"default": "", "def_order": 7, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "sort_by": {"default": "", "def_order": 6, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "filter": {"default": "", "def_order": 3, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "offset": {"default": 0, "def_order": 5, "doc_lines": ["Number of servers to skip"], "type": "number", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from keyname and secret key value"], "type": "string", "optional": false}}}, "remoteSignZone": {"ret_info": {"doc_lines": [], "type": "boolean"}, "doc_lines": ["Sign zone <i>zonename</i> on remote server or server cluster.", ""], "params": {"viewname": {"def_order": 4, "doc_lines": ["Name of the view"], "type": "string", "optional": false}, "clustername": {"default": "", "def_order": 8, "doc_lines": ["Cluster name where the operation is done"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 6, "doc_lines": ["Server name where the operation is done"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 7, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "when": {"default": "", "def_order": 5, "doc_lines": ["Time at which the specified operation should take effect. <i>RESERVED FOR FUTURE USE. NOT SUPPORTED AT THE MOMENT.</i>"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from servername or clustername"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Name of the zone"], "type": "string", "optional": false}}}, "reserveIpBySubnet": {"ret_info": {"doc_lines": ["Returns the newly created IPAMHostWithBlock. If auto_hostname is true, generated hostname is provided in the infos as \"Hostname\"."], "type": "IPAMHostWithBlock"}, "doc_lines": ["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.", ""], "params": {"bitmask": {"def_order": 4, "doc_lines": ["Subnet bitmask"], "type": "number", "optional": false}, "prefix": {"def_order": 3, "doc_lines": ["Subnet prefix"], "type": "string", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "add_dns": {"default": false, "def_order": 7, "doc_lines": ["Select whether to add new host to dns"], "type": "boolean", "optional": true}, "auto_hostname": {"default": true, "def_order": 6, "doc_lines": ["Autogenerate hostname using default zone and host pattern for the block"], "type": "boolean", "optional": true}, "owner": {"default": "", "def_order": 5, "doc_lines": ["IPAM Owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from prefix and bitmask"], "type": "string", "optional": false}}}, "remoteUpdateZone": {"ret_info": {"doc_lines": ["True if successfully removed"], "type": "boolean"}, "doc_lines": ["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).", ""], "params": {"parameters": {"default": [], "def_order": 8, "doc_lines": ["Optional list of key/value pairs. Reserved for future use."], "type": ["KVParameter"], "optional": true}, "viewname": {"default": "", "def_order": 4, "doc_lines": ["Viewname (optional)"], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 7, "doc_lines": ["Server cluster, where the zone is removed from"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 5, "doc_lines": ["Server name, where the zone is removed from"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 6, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename, viewname and either server name or cluster name"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone to delete"], "type": "string", "optional": false}}}, "listZones": {"ret_info": {"doc_lines": ["Returns a list of DNSZone objects"], "type": ["DNSZone"]}, "doc_lines": ["List all zones or zones of specified type", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "mode": {"default": "forward", "def_order": 3, "doc_lines": ["Select whether to list forward, reverse or all zones (accepts forward / reverse / all)"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from keyname and secret key value"], "type": "string", "optional": false}}}, "remoteListViews": {"ret_info": {"doc_lines": ["Returns a list of view names"], "type": ["MinimalView"]}, "doc_lines": ["List views from remote server or server cluster", ""], "params": {"count": {"default": -1, "def_order": 7, "doc_lines": ["Number of views to return"], "type": "number", "optional": true}, "sort_dir": {"default": "", "def_order": 10, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 6, "doc_lines": ["Cluster name where the operation is done"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 4, "doc_lines": ["Server name where the operation is done"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 5, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "sort_by": {"default": "", "def_order": 9, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "filter": {"default": "", "def_order": 3, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "offset": {"default": 0, "def_order": 8, "doc_lines": ["Number of views to skip"], "type": "number", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from either servername or clustername"], "type": "string", "optional": false}}}, "fetchBlock": {"ret_info": {"doc_lines": ["Returns an IPAMBlock"], "type": "IPAMBlock"}, "doc_lines": ["Fetch a given block", ""], "params": {"owner": {"default": "", "def_order": 5, "doc_lines": ["Optional owner to differentiate between blocks"], "type": "string", "optional": true}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the block to be fetched"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address and bitmask"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Address of the block to be fetched"], "type": "string", "optional": false}}}, "searchBlocks": {"ret_info": {"doc_lines": ["List of IPAMBlocks matching search criteria"], "type": ["IPAMBlock"]}, "doc_lines": ["Search blocks with zero or more conditions. Empty (default) values means \"match anything\"", ""], "params": {"count": {"default": -1, "def_order": 9, "doc_lines": ["Maximum number of results to return"], "type": "number", "optional": true}, "bitmask": {"default": 0, "def_order": 4, "doc_lines": ["Match specific bitmask"], "type": "number", "optional": true}, "infokey": {"default": "", "def_order": 6, "doc_lines": ["Match infofield name, wildcard can be used as part of infokey"], "type": "string", "optional": true}, "ignorecase": {"default": false, "def_order": 8, "doc_lines": ["Perform case insensitive search when set to True"], "type": "boolean", "optional": true}, "prefix": {"default": "", "def_order": 3, "doc_lines": ["Search blocks that match prefix, wildcard can be used at the end of prefix"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "infovalue": {"default": "", "def_order": 7, "doc_lines": ["Match infofield value, wildcard can be used as part of infovalue"], "type": "string", "optional": true}, "offset": {"default": 0, "def_order": 10, "doc_lines": ["Skip first <i>offset</i> results"], "type": "number", "optional": true}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Match owner, wildcard can be used as a part of owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from prefix, bitmask, owner, infokey and infofield"], "type": "string", "optional": false}}}, "reserveBlockWithInfos": {"ret_info": {"doc_lines": [], "type": "IPAMBlock"}, "doc_lines": ["Reserve the first available block with bitmask <i>bitmask</i> from location that matches infos"], "params": {"subnet": {"def_order": 6, "doc_lines": ["Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block."], "type": "string", "optional": false}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask for the new, reserved block"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "owner": {"def_order": 3, "doc_lines": ["Owner of the block (Optional)"], "type": "string", "optional": false}, "blocktype": {"def_order": 5, "doc_lines": ["Type of new block (normal, address_set, delegated)"], "type": "string", "optional": false}, "infos": {"default": [], "def_order": 7, "doc_lines": ["Array of IPAMInfos that are used to find a location for the new block"], "type": ["IPAMInfo"], "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from info names and values"], "type": "string", "optional": false}}}, "deleteHost": {"ret_info": {"doc_lines": ["Returns True/False"], "type": "boolean"}, "doc_lines": ["Delete specified host", ""], "params": {"delete_reverse": {"default": true, "def_order": 5, "doc_lines": ["Delete reverse DNS PTR records which point to the matching A/AAAA records"], "type": "boolean", "optional": true}, "views": {"default": [], "def_order": 6, "doc_lines": ["DNS views that DNS deletes will be limited to"], "type": ["string"], "optional": true}, "host": {"def_order": 3, "doc_lines": ["IPAMHost representing host to be deleted"], "type": "IPAMHost", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API Key name"], "type": "string", "optional": false}, "delete_forward": {"default": "host", "def_order": 4, "doc_lines": ["[no|host|hostdata], \"host\" = Delete DNS hosts (A/AAAA records pointing to host IP), \"hostdata\" = Delete also hosts' DNS nodes (incl. any contained records)"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated from host address and host owner (see param <i>host</i>)"], "type": "string", "optional": false}}}, "remoteListZones": {"ret_info": {"doc_lines": ["Returns a list of MinimalZone objects"], "type": ["MinimalZone"]}, "doc_lines": ["List zones from remote server or server cluster", ""], "params": {"count": {"default": -1, "def_order": 7, "doc_lines": ["Number of servers to return"], "type": "number", "optional": true}, "sort_dir": {"default": "", "def_order": 10, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 6, "doc_lines": ["Cluster name where the operation is done"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 4, "doc_lines": ["Server name where the operation is done"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 5, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "sort_by": {"default": "", "def_order": 9, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "filter": {"default": "", "def_order": 3, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "offset": {"default": 0, "def_order": 8, "doc_lines": ["Number of servers to skip"], "type": "number", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from either servername or clustername"], "type": "string", "optional": false}}}, "deleteZone": {"ret_info": {"doc_lines": ["Returns True if zone was successfully removed"], "type": "boolean"}, "doc_lines": ["Remove zone from NameSurfer", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API Key name"], "type": "string", "optional": false}, "viewname": {"default": "", "def_order": 4, "doc_lines": ["Optional view name"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated using zonename and viewname"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone name to remove"], "type": "string", "optional": false}}}, "searchDNSChanges": {"ret_info": {"doc_lines": ["List of matching DNSChange objects."], "type": ["DNSChange"]}, "doc_lines": ["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).", ""], "params": {"date_from": {"default": "", "def_order": 9, "doc_lines": ["If specified, omit changes earlier than this (defaults to previous day at 00:00:00)"], "type": "string", "optional": true}, "offset": {"default": 0, "def_order": 11, "doc_lines": ["Number of changes to skip from beginning, default 0"], "type": "number", "optional": true}, "view_pattern": {"default": "", "def_order": 4, "doc_lines": ["If specified, view names must match this pattern"], "type": "string", "optional": true}, "user_pattern": {"default": "", "def_order": 8, "doc_lines": ["If specified, logged user names must match this pattern"], "type": "string", "optional": true}, "data_pattern": {"default": "", "def_order": 6, "doc_lines": ["If specified, value data must match this pattern"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "limit": {"default": 100, "def_order": 12, "doc_lines": ["Maximum number of changes to return, default 100 (set to -1 to disable limit)"], "type": "number", "optional": true}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}, "date_to": {"default": "", "def_order": 10, "doc_lines": ["If this and date_from are specified, omit changes newer than this"], "type": "string", "optional": true}, "rr_type": {"default": "", "def_order": 7, "doc_lines": ["If specified, changes must contain a value of this RR type"], "type": "string", "optional": true}, "zone_pattern": {"default": "", "def_order": 3, "doc_lines": ["If specified, zone names must match this pattern"], "type": "string", "optional": true}, "name_pattern": {"default": "", "def_order": 5, "doc_lines": ["If specified, node names must match this pattern"], "type": "string", "optional": true}}}, "addHost": {"ret_info": {"doc_lines": ["Returns the new created host as IPAMHost"], "type": "IPAMHost"}, "doc_lines": ["Add a host to IPAM", ""], "params": {"force": {"default": false, "def_order": 9, "doc_lines": ["Ignore possible warnings"], "type": "boolean", "optional": true}, "dnsname": {"default": "", "def_order": 6, "doc_lines": ["Optional DNS name"], "type": "string", "optional": true}, "location": {"def_order": 3, "doc_lines": ["IPAMBlock representing the location to add new host into"], "type": "IPAMBlock", "optional": false}, "address": {"def_order": 4, "doc_lines": ["Address of the new host"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Optional owner. Uses owner of the location if left empty"], "type": "string", "optional": true}, "infos": {"default": [], "def_order": 8, "doc_lines": ["List of IPAMInfo elements that will be added to host"], "type": ["IPAMInfo"], "optional": true}, "view": {"default": "", "def_order": 7, "doc_lines": ["Optional DNS view"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from address, dnsname and view"], "type": "string", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API Key name"], "type": "string", "optional": false}}}, "updateBlock": {"ret_info": {"doc_lines": ["Return true if successfully updated, otherwise false"], "type": "boolean"}, "doc_lines": ["Update owner or type of given IPAM block", ""], "params": {"newowner": {"default": "", "def_order": 6, "doc_lines": ["New owner of the block"], "type": "string", "optional": true}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the block to be updated"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name used"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Address of the block to be updated"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Original owner of the block"], "type": "string", "optional": true}, "newtype": {"default": "", "def_order": 7, "doc_lines": ["New type of the block"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address, bitmask, owner, newowner and newtype"], "type": "string", "optional": false}}}, "remoteServerStop": {"ret_info": {"doc_lines": ["True if successfully started"], "type": "boolean"}, "doc_lines": ["Stop remote server"], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "reserveIpByInfos": {"ret_info": {"doc_lines": ["Returns the newly created IPAMHostWithBlock. If auto_hostname is true, generated hostname is provided in the infos as \"Hostname\"."], "type": "IPAMHostWithBlock"}, "doc_lines": ["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.", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "add_dns": {"default": false, "def_order": 6, "doc_lines": ["Select whether to add new host to dns"], "type": "boolean", "optional": true}, "auto_hostname": {"default": true, "def_order": 5, "doc_lines": ["Autogenerate hostname using default zone and host pattern for the block"], "type": "boolean", "optional": true}, "owner": {"default": "", "def_order": 4, "doc_lines": ["Optional owner"], "type": "string", "optional": true}, "infos": {"def_order": 3, "doc_lines": ["A list of IPAMInfo DTOs"], "type": ["IPAMInfo"], "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from info names and values"], "type": "string", "optional": false}}}, "addZone": {"ret_info": {"doc_lines": ["Return true if zone was successfully added"], "type": "boolean"}, "doc_lines": ["Add a new zone. If clustername is specified the zonetype parameter can be left empty.", ""], "params": {"soa": {"def_order": 4, "doc_lines": ["Zone SOA record in full"], "type": "string", "optional": false}, "masters": {"default": [], "def_order": 8, "doc_lines": ["(secondary only) Master servers of a secondary zone, list of MasterNS)"], "type": ["MasterNS"], "optional": true}, "viewname": {"default": "", "def_order": 6, "doc_lines": ["Optional view name"], "type": "string", "optional": true}, "nameservers": {"default": [], "def_order": 5, "doc_lines": ["List of name servers to add to zone"], "type": ["string"], "optional": true}, "forward_updates": {"default": true, "def_order": 9, "doc_lines": ["(secondary only) Set to False to disable DDNS updates of the zone to masters."], "type": "boolean", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "isprimary": {"default": true, "def_order": 7, "doc_lines": ["Normally creates primary zones. Set to False to create a secondary zone."], "type": "boolean", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename and viewname"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone to create"], "type": "string", "optional": false}}}, "remoteUnSignZone": {"ret_info": {"doc_lines": [], "type": "boolean"}, "doc_lines": ["Unsign zone <i>zonename</i> on remote server or server cluster.", ""], "params": {"viewname": {"def_order": 4, "doc_lines": ["Name of the view"], "type": "string", "optional": false}, "clustername": {"default": "", "def_order": 8, "doc_lines": ["Cluster name where the operation is done"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 6, "doc_lines": ["Server name where the operation is done <i>RESERVED FOR FUTURE USE. NOT SUPPORTED AT THE MOMENT.</i>"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 7, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "when": {"default": "", "def_order": 5, "doc_lines": ["Time at which the specified operation should take effect"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename, viewname and servername or clustername"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Name of the zone"], "type": "string", "optional": false}}}, "deleteBlock": {"ret_info": {"doc_lines": [], "type": "boolean"}, "doc_lines": ["Remove the specified block from IPAM", ""], "params": {"force": {"default": false, "def_order": 6, "doc_lines": ["Delete block even if not empty"], "type": "boolean", "optional": true}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the block to be deleted"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Address of the block to be deleted"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Block owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address and bitmask"], "type": "string", "optional": false}}}, "remoteDeleteZone": {"ret_info": {"doc_lines": ["True if successfully removed"], "type": "boolean"}, "doc_lines": ["Delete zone from remote server or server cluster.", "", "Zone can be removed either from a single server or from a server cluster.", ""], "params": {"viewname": {"default": "", "def_order": 4, "doc_lines": ["Viewname (optional)"], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 7, "doc_lines": ["Server cluster, where the zone is removed from"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 5, "doc_lines": ["Server name, where the zone is removed from"], "type": "string", "optional": true}, "servertype": {"default": "", "def_order": 6, "doc_lines": ["Used to differentiate between different server types running on same server"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename, viewname and either server name or cluster name"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone to delete"], "type": "string", "optional": false}}}, "addBlock": {"ret_info": {"doc_lines": ["Return true if adding succeeded, otherwise false"], "type": "boolean"}, "doc_lines": ["Add a new block to IPAM", ""], "params": {"subnet": {"default": false, "def_order": 8, "doc_lines": ["Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block."], "type": "boolean", "optional": true}, "family": {"def_order": 5, "doc_lines": ["Address family (IPv4/IPv6)"], "type": "string", "optional": false}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the new block"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name used"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Prefix (address) of the new block"], "type": "string", "optional": false}, "owner": {"def_order": 6, "doc_lines": ["Owner of the block"], "type": "string", "optional": false}, "blocktype": {"def_order": 7, "doc_lines": ["Type of new block (normal, address_set, delegated)"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from location, address, bitmask, family, owner  and block type"], "type": "string", "optional": false}}}, "searchZones": {"ret_info": {"doc_lines": ["List of DNSZone objects found"], "type": ["DNSZone"]}, "doc_lines": ["Search zones matching zone pattern", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonepattern"], "type": "string", "optional": false}, "zonepattern": {"default": "", "def_order": 3, "doc_lines": ["Search zones matching this pattern"], "type": "string", "optional": true}}}, "remoteServerRestart": {"ret_info": {"doc_lines": ["True if successfully started"], "type": "boolean"}, "doc_lines": ["Restart remote server"], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "searchHosts": {"ret_info": {"doc_lines": ["List of IPAMHosts matching search criteria"], "type": ["IPAMHost"]}, "doc_lines": ["Search hosts with zero or more conditions. Empty (default) values means \"match anything\"", ""], "params": {"count": {"default": -1, "def_order": 9, "doc_lines": ["Maximum number of results to return"], "type": "number", "optional": true}, "offset": {"default": 0, "def_order": 10, "doc_lines": ["Skip first <i>offset</i> results"], "type": "number", "optional": true}, "infokey": {"default": "", "def_order": 6, "doc_lines": ["Match infofield name, wildcard can be used as part of infokey"], "type": "string", "optional": true}, "ignorecase": {"default": true, "def_order": 8, "doc_lines": ["Perform case insensitive search when set to True"], "type": "boolean", "optional": true}, "bitmask": {"default": 0, "def_order": 4, "doc_lines": ["Match specific bitmask"], "type": "number", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "infovalue": {"default": "", "def_order": 7, "doc_lines": ["Match infofield value, wildcard can be used as part of infovalue"], "type": "string", "optional": true}, "address": {"default": "", "def_order": 3, "doc_lines": ["Search hosts that match address wildcard can be used at the end of prefix"], "type": "string", "optional": true}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Match owner, wildcard can be used as a part of owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address, owner, infokey and infofield"], "type": "string", "optional": false}}}, "countBlocks": {"ret_info": {"doc_lines": ["Returns the number of blocks"], "type": "number"}, "doc_lines": ["Count number of blocks in a given location", ""], "params": {"recurse": {"default": false, "def_order": 5, "doc_lines": ["Count recursively all sub blocks"], "type": "boolean", "optional": true}, "bitmask": {"default": -1, "def_order": 4, "doc_lines": [], "type": "number", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key"], "type": "string", "optional": false}, "location": {"def_order": 3, "doc_lines": ["Network address to start calculating from"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 6, "doc_lines": ["Count only blocks owned by <i>owner</i>. Leave empty to count all blocks. (Optional)"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from location"], "type": "string", "optional": false}}}, "updateBlockInfo": {"ret_info": {"doc_lines": ["Return true if update succeeds, otherwise return false"], "type": "boolean"}, "doc_lines": ["Update info field(s) for a given block", ""], "params": {"bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the updated block"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Address of the updated block"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Owner of the updated block"], "type": "string", "optional": true}, "infos": {"default": [], "def_order": 6, "doc_lines": ["List of IPAMInfo objects to set"], "type": ["IPAMInfo"], "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address, bitmask and owner"], "type": "string", "optional": false}}}, "searchDNSHosts": {"ret_info": {"doc_lines": ["List of DNSNode objects found"], "type": ["DNSNode"]}, "doc_lines": ["Search DNS hosts matching host pattern", ""], "params": {"hostpattern": {"default": "", "def_order": 3, "doc_lines": ["Search hosts matching this pattern"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated from hostpattern"], "type": "string", "optional": false}}}, "listBlocks": {"ret_info": {"doc_lines": ["Return a list of IPAMBlocks"], "type": ["IPAMBlock"]}, "doc_lines": ["Fetch list of IPAM blocks inside <i>location</i>.<br/>", "<b>NOTE : </b>Result list <b>DOES NOT</b> include block given as starting point in <i>location</i>. ", ""], "params": {"recurse": {"default": false, "def_order": 6, "doc_lines": ["Also return child blocks, if limit > 0. Disables \"offset\" parameter."], "type": "boolean", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key"], "type": "string", "optional": false}, "limit": {"default": -1, "def_order": 5, "doc_lines": ["If recurse=false (default), maximum number of blocks to return. If recurse=true, maximum tree depth to return."], "type": "number", "optional": true}, "location": {"def_order": 3, "doc_lines": ["Starting point to list blocks from. Leave empty to list from top level."], "type": "string", "optional": false}, "offset": {"default": 0, "def_order": 4, "doc_lines": ["Number of blocks to omit from beginning of list. If recurse=true, must be 0 or omitted."], "type": "number", "optional": true}, "owner": {"default": "", "def_order": 7, "doc_lines": ["List blocks owned by <i>owner</i>"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from location"], "type": "string", "optional": false}}}, "reserveBlockWithLocation": {"ret_info": {"doc_lines": [], "type": "IPAMBlock"}, "doc_lines": ["Reserve the first available block with bitmask <i>bitmask</i> from the given location"], "params": {"subnet": {"def_order": 6, "doc_lines": ["Is the block used as a subnet. If true, NameSurfer reserves the first and last IP address of the block."], "type": "boolean", "optional": false}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask for the new, reserved block"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "location": {"def_order": 3, "doc_lines": ["Block where to reserve from"], "type": "IPAMBlock", "optional": false}, "blocktype": {"def_order": 5, "doc_lines": ["Type of new block (normal, address_set, delegated)"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from location network address, bitmask and owner"], "type": "string", "optional": false}}}, "updateHost": {"ret_info": {"doc_lines": ["Returns True/False"], "type": "boolean"}, "doc_lines": ["Updates specified host", ""], "params": {"force": {"default": false, "def_order": 6, "doc_lines": ["Whether to ignore possible warnings"], "type": "boolean", "optional": true}, "new_owner": {"default": "", "def_order": 4, "doc_lines": ["Change the owner of the host by setting this"], "type": "string", "optional": true}, "host": {"def_order": 3, "doc_lines": ["IPAMHost representing host to be updated"], "type": "IPAMHost", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API Key name"], "type": "string", "optional": false}, "infos": {"default": [], "def_order": 5, "doc_lines": ["List of IPAMInfos to add/modify"], "type": ["IPAMInfo"], "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated with host address and host owner (see param <i>host</i>)"], "type": "string", "optional": false}}}, "clearBlock": {"ret_info": {"doc_lines": [], "type": "boolean"}, "doc_lines": ["Clear the specified block from IPAM", "Deletes block contents but leaves the block", ""], "params": {"force": {"default": true, "def_order": 6, "doc_lines": ["Ignore possible warnings and clear"], "type": "boolean", "optional": true}, "bitmask": {"def_order": 4, "doc_lines": ["Bitmask of the block to be deleted"], "type": "number", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "address": {"def_order": 3, "doc_lines": ["Address of the block to be deleted"], "type": "string", "optional": false}, "owner": {"default": "", "def_order": 5, "doc_lines": ["Block owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Digest calculated from address and bitmask"], "type": "string", "optional": false}}}, "listRemoteClusters": {"ret_info": {"doc_lines": ["List of cluster objects"], "type": ["RemoteClusterDTO"]}, "doc_lines": ["List server clusters API key <i>keyname</i> has access to.", ""], "params": {"count": {"default": -1, "def_order": 4, "doc_lines": ["Number of clusters to return"], "type": "number", "optional": true}, "sort_dir": {"default": "", "def_order": 7, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "sort_by": {"default": "", "def_order": 6, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "filter": {"default": "", "def_order": 3, "doc_lines": ["Reserved for future improvements"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "offset": {"default": 0, "def_order": 5, "doc_lines": ["Number of clusters to skip"], "type": "number", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from keyname and secret key value"], "type": "string", "optional": false}}}, "listHosts": {"ret_info": {"doc_lines": ["List of IPAMHosts found"], "type": ["IPAMHost"]}, "doc_lines": ["List hosts under a given location", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "recurse": {"default": false, "def_order": 4, "doc_lines": ["Whether to recurse into blocks below location"], "type": "boolean", "optional": true}, "location": {"def_order": 3, "doc_lines": ["IPAMBlock representation of the location, set location.network to <i>0.0.0.0</i> to list from RootBlocks"], "type": "IPAMBlock", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated from location.network and location.bitmask"], "type": "string", "optional": false}}}, "listBlocksByInfos": {"ret_info": {"doc_lines": ["Returns a list of IPAMBlock objects. Only blocks that have free IP addresses will be returned."], "type": ["IPAMBlock"]}, "doc_lines": ["Search IPAM blocks by given info fields. Returns a list of IPAMBlock objects.", "Only blocks that have free IP addresses will be returned.", ""], "params": {"owner": {"default": "", "def_order": 4, "doc_lines": ["Optional owner"], "type": "string", "optional": true}, "infos": {"def_order": 3, "doc_lines": ["A list of IPAMInfo DTOs"], "type": ["IPAMInfo"], "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from info names and values"], "type": "string", "optional": false}}}, "fetchZone": {"ret_info": {"doc_lines": ["Return a DNSZone"], "type": "DNSZone"}, "doc_lines": ["Fetch information for the given zone", ""], "params": {"keyname": {"def_order": 1, "doc_lines": ["API Key name"], "type": "string", "optional": false}, "viewname": {"default": "", "def_order": 4, "doc_lines": ["Optional view name"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated using zonename and viewname"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Zone name to fetch"], "type": "string", "optional": false}}}, "remoteServerUploadConfiguration": {"ret_info": {"doc_lines": ["True if successfully started"], "type": ["RemoteServerConfiguration"]}, "doc_lines": ["Upload configuration from NameSurfer's database to remote server"], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "reserveMultipleIpsByInfos": {"ret_info": {"doc_lines": ["Returns a list of newly created IPAMHostWithBlocks. If auto_hostname is true, generated hostname is provided in the infos as \"Hostname\"."], "type": ["IPAMHostWithBlock"]}, "doc_lines": ["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.", ""], "params": {"amount": {"default": 1, "def_order": 7, "doc_lines": ["Number of IPs to reserve, default is one (1)"], "type": "number", "optional": true}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "add_dns": {"default": false, "def_order": 6, "doc_lines": ["Select whether to add new host to dns"], "type": "boolean", "optional": true}, "auto_hostname": {"default": true, "def_order": 5, "doc_lines": ["Autogenerate hostname using default zone and host pattern for the block"], "type": "boolean", "optional": true}, "owner": {"default": "", "def_order": 4, "doc_lines": ["Optional owner"], "type": "string", "optional": true}, "infos": {"def_order": 3, "doc_lines": ["A list of IPAMInfo DTOs"], "type": ["IPAMInfo"], "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from info names and values"], "type": "string", "optional": false}}}, "remoteServerExportConfiguration": {"ret_info": {"doc_lines": ["True if successfully started"], "type": ["RemoteServerConfiguration"]}, "doc_lines": ["Export remote server configuration."], "params": {"servertype": {"default": "", "def_order": 4, "doc_lines": ["Used to differentiate between different server types running on same server."], "type": "string", "optional": true}, "clustername": {"default": "", "def_order": 5, "doc_lines": ["Server cluster, where the zone is added to"], "type": "string", "optional": true}, "servername": {"default": "", "def_order": 3, "doc_lines": ["Server name, where the zone is added to"], "type": "string", "optional": true}, "keyname": {"def_order": 1, "doc_lines": [], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": [], "type": "string", "optional": false}}}, "deleteDNSHost": {"ret_info": {"doc_lines": ["Returns true if successfully deleted, otherwise returns false"], "type": "boolean"}, "doc_lines": ["Delete specified host", ""], "params": {"delete_reverse": {"default": true, "def_order": 6, "doc_lines": ["Delete matching PTR records (default: True)"], "type": "boolean", "optional": true}, "viewname": {"def_order": 5, "doc_lines": ["View where said zone is in"], "type": "string", "optional": false}, "hostname": {"def_order": 3, "doc_lines": ["Hostname to be deleted (may contain zone name)"], "type": "string", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Message digest calculated from hostname, zonename and viewname"], "type": "string", "optional": false}, "zonename": {"def_order": 4, "doc_lines": ["Zone to delete host from"], "type": "string", "optional": false}}}, "reserveMultipleIpsBySubnet": {"ret_info": {"doc_lines": ["Returns the newly created IPAMHostWithBlocks. If auto_hostname is true, generated hostname is provided in the infos as \"Hostname\"."], "type": ["IPAMHostWithBlock"]}, "doc_lines": ["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.", ""], "params": {"count": {"default": 1, "def_order": 8, "doc_lines": [], "type": "number", "optional": true}, "bitmask": {"def_order": 4, "doc_lines": ["Subnet bitmask"], "type": "number", "optional": false}, "prefix": {"def_order": 3, "doc_lines": ["Subnet prefix"], "type": "string", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "add_dns": {"default": false, "def_order": 7, "doc_lines": ["Select whether to add new host to dns"], "type": "boolean", "optional": true}, "auto_hostname": {"default": true, "def_order": 6, "doc_lines": ["Autogenerate hostname using default zone and host pattern for the block"], "type": "boolean", "optional": true}, "owner": {"default": "", "def_order": 5, "doc_lines": ["IPAM Owner"], "type": "string", "optional": true}, "digest": {"def_order": 2, "doc_lines": ["Calculated from prefix and bitmask"], "type": "string", "optional": false}}}, "addDNSRecord": {"ret_info": {"doc_lines": ["Returns true if DNSNode was successfully added, otherwise raises APIFault with error message"], "type": "boolean"}, "doc_lines": ["Add a DNS record, creating the node if missing<br/>", "When adding NS record, leave the <i>name</i> field of <i>record</i> empty unless you want to add delegation. "], "params": {"record": {"def_order": 5, "doc_lines": ["DNSNode object populated with data"], "type": "DNSNode", "optional": false}, "keyname": {"def_order": 1, "doc_lines": ["API key name"], "type": "string", "optional": false}, "viewname": {"def_order": 4, "doc_lines": ["Add record into zone in this view, leave empty to add into Default view"], "type": "string", "optional": false}, "digest": {"def_order": 2, "doc_lines": ["Calculated from zonename, viewname, record.name, record.type, record.ttl and record.data"], "type": "string", "optional": false}, "zonename": {"def_order": 3, "doc_lines": ["Add record into this zone"], "type": "string", "optional": false}}}}}