26 Detached Objects
The structure of the objects returned by the functions in this chapter may vary depending on the anynode version.
26.1 Get-anynodeSorts
Returns (depending on its paramters) a list of object sorts, a list of objects of a specific sort or a single object of a specific sort.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
If this parameter is supplied additionally to the sort only the object with this display name will be returned.
-
string: Sort
If this parameter is not present, a list of all sorts will be returned. If a sort is selected with this parameter, all objects of that sort are returned.
Possible values:
-
USRAGG_DIRECTORY (Aggregate Directory)
-
AN_SIPLB_STACK (Load Balancer)
-
AN_SIPRT_ROUTE (Standard Transport Connection)
-
AZURE_ACTIVE_DIRECTORY (Azure Active Directory)
-
CAPIC_STACK (CAPI Client)
-
CAPIS_STACK (XCAPI Controller)
-
CAPIS_DOMAIN (XCAPI Controller Domain)
-
CS_CONDITION (Condition)
-
CS_SCHEDULER (Rate Limiter)
-
CS_STUB (Stub)
-
USRDB_DIRECTORY (Database Connected Directory)
-
CRY_X509_STACK (Digital Identity and Trust)
-
USRRT_ROUTE_SV (Directory Route Supervision)
-
MISC_TIME_REPORTER (Time Range)
-
MEDIA_PUMP_DOMAIN (Media Transcoding Options)
-
HTTP_SERVER (HTTP Server)
-
HTTP_CLIENT (HTTP Client)
-
IN_FILTER (Network Peer Whitelist)
-
IN_MAP_STACK (Network Mapping)
-
IN_MAP_STATIC_STACK (Network Static Mapping)
-
IN_STACK (Network Controller)
-
IPC_CLIENT (IPC Client)
-
IPC_SERVER (IPC Server)
-
LDAP_CONNECTION (LDAP Client Connection)
-
USRLDAP_DIRECTORY (LDAP Directory)
-
MNS_TEAMS_DOMAIN (Media Negotiation (Microsoft Teams Extensions))
-
MNS_FORWARDER_DOMAIN (Media Negotiation Forwarder)
-
MNS_STACK (Media Negotiation)
-
REC_STACK (Media Recorder)
-
RECMUX_STACK (Media Recording Multiplexer)
-
RECFILE_STACK (Media File Recorder)
-
RECTEL_STACK (Media Telephony Recorder)
-
MS_AUDIO_PROVIDER (Audio Media Source)
-
MSFILE_PROVIDER (File Media Source)
-
MS_GRAPH_CLIENT (Microsoft Graph Client)
-
TELTEAMS_STACK (Microsoft Teams Connectivity)
-
TELTEAMS_TENANT (Microsoft Teams Tenant)
-
INS_STACK (Network Security Profile)
-
NUMVALRT_ROUTE_SV (Number Validation Route Supervision)
-
OAUTH_CLIENT (OAuth Client)
-
PROVISIONING_SERVER (Provisioning Server)
-
IN_QOS_STACK (QoS Profile)
-
RESTRT_ROUTE_SV (REST Client Route Supervision)
-
SIPAUTH_STACK (Authentication Profile)
-
SIPLB_STACK (Load Balancing Transport Connection)
-
SIPPX_STACK (Request Router)
-
RECSIPREC_STACK (SIPREC Media Recorder)
-
TELSIPREG_REGISTRAR (SIP Registrar)
-
SIPRT_PLAIN_ROUTE (Plain Transport Connection)
-
SIPST_STACK (SIP Transport)
-
SIPUA_REGISTRATION (SIP Registration)
-
SIPUA_STACK (SIP User Agent)
-
SRVLB_STACK (SRV Load Balancer)
-
USRTEL_DIRECTORY (Static Dial string Directory)
-
USRT_DIRECTORY (Static User Directory)
-
MSTEL_PROVIDER (Telephony Media Source)
-
TELELIN_DOMAIN (ELIN Binding Database)
-
TELFW_STACK (Telephony Forwarding)
-
TEL_REWRITE_DOMAIN (Dial String Rewriting)
-
TELRT_FORWARDER_DOMAIN (Routing Forward Profile)
-
TELRT_STACK (Routing Domain)
-
TEL_STACK (Node)
-
TELCAPIC_STACK (CAPI Client Node)
-
TELCAPIS_STACK (XCAPI Controller Node)
-
TELSIP_STACK (SIP Node)
-
TELUCMA_STACK (SfB UCMA Node)
-
TELWEBRTC_STACK (WebRTC Node)
-
WEBRTC_STACK (WebRTC Server)
-
WEBSOCKET_STACK (Websocket)
-
26.2 Get-anynodeObject
Returns the configuration of a object identified by it's id.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The id of the object that should be returned
26.3 Get-anynodeUnreferencedObjects
Returns a list of unreferenced objects of a specific sort.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Sort
The sort of objects that will be returned. For a list of all objects sorts use section 26.1
26.4 Get-anynodeObjectTree
Returns the tree of an object in the configuration.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The id of the object which tree should be returned
26.5 Get-anynodeSubTreeObjects
Returns all child objects of a specific type.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The id of the object which child objects should be returned
-
string: Sort
The sort of the child objects.
Possible values:
-
USRAGG_DIRECTORY (Aggregate Directory)
-
AN_SIPLB_STACK (Load Balancer)
-
AN_SIPRT_ROUTE (Standard Transport Connection)
-
AZURE_ACTIVE_DIRECTORY (Azure Active Directory)
-
CAPIC_STACK (CAPI Client)
-
CAPIS_STACK (XCAPI Controller)
-
CAPIS_DOMAIN (XCAPI Controller Domain)
-
CS_CONDITION (Condition)
-
CS_SCHEDULER (Rate Limiter)
-
CS_STUB (Stub)
-
USRDB_DIRECTORY (Database Connected Directory)
-
CRY_X509_STACK (Digital Identity and Trust)
-
USRRT_ROUTE_SV (Directory Route Supervision)
-
MISC_TIME_REPORTER (Time Range)
-
MEDIA_PUMP_DOMAIN (Media Transcoding Options)
-
HTTP_SERVER (HTTP Server)
-
HTTP_CLIENT (HTTP Client)
-
IN_FILTER (Network Peer Whitelist)
-
IN_MAP_STACK (Network Mapping)
-
IN_MAP_STATIC_STACK (Network Static Mapping)
-
IN_STACK (Network Controller)
-
IPC_CLIENT (IPC Client)
-
IPC_SERVER (IPC Server)
-
LDAP_CONNECTION (LDAP Client Connection)
-
USRLDAP_DIRECTORY (LDAP Directory)
-
MNS_TEAMS_DOMAIN (Media Negotiation (Microsoft Teams Extensions))
-
MNS_FORWARDER_DOMAIN (Media Negotiation Forwarder)
-
MNS_STACK (Media Negotiation)
-
REC_STACK (Media Recorder)
-
RECMUX_STACK (Media Recording Multiplexer)
-
RECFILE_STACK (Media File Recorder)
-
RECTEL_STACK (Media Telephony Recorder)
-
MS_AUDIO_PROVIDER (Audio Media Source)
-
MSFILE_PROVIDER (File Media Source)
-
MS_GRAPH_CLIENT (Microsoft Graph Client)
-
TELTEAMS_STACK (Microsoft Teams Connectivity)
-
TELTEAMS_TENANT (Microsoft Teams Tenant)
-
INS_STACK (Network Security Profile)
-
NUMVALRT_ROUTE_SV (Number Validation Route Supervision)
-
OAUTH_CLIENT (OAuth Client)
-
PROVISIONING_SERVER (Provisioning Server)
-
IN_QOS_STACK (QoS Profile)
-
RESTRT_ROUTE_SV (REST Client Route Supervision)
-
SIPAUTH_STACK (Authentication Profile)
-
SIPLB_STACK (Load Balancing Transport Connection)
-
SIPPX_STACK (Request Router)
-
RECSIPREC_STACK (SIPREC Media Recorder)
-
TELSIPREG_REGISTRAR (SIP Registrar)
-
SIPRT_PLAIN_ROUTE (Plain Transport Connection)
-
SIPST_STACK (SIP Transport)
-
SIPUA_REGISTRATION (SIP Registration)
-
SIPUA_STACK (SIP User Agent)
-
SRVLB_STACK (SRV Load Balancer)
-
USRTEL_DIRECTORY (Static Dial string Directory)
-
USRT_DIRECTORY (Static User Directory)
-
MSTEL_PROVIDER (Telephony Media Source)
-
TELELIN_DOMAIN (ELIN Binding Database)
-
TELFW_STACK (Telephony Forwarding)
-
TEL_REWRITE_DOMAIN (Dial String Rewriting)
-
TELRT_FORWARDER_DOMAIN (Routing Forward Profile)
-
TELRT_STACK (Routing Domain)
-
TEL_STACK (Node)
-
TELCAPIC_STACK (CAPI Client Node)
-
TELCAPIS_STACK (XCAPI Controller Node)
-
TELSIP_STACK (SIP Node)
-
TELUCMA_STACK (SfB UCMA Node)
-
TELWEBRTC_STACK (WebRTC Node)
-
WEBRTC_STACK (WebRTC Server)
-
WEBSOCKET_STACK (Websocket)
-
26.6 Set-anynodeObject
Modifies the options of a single object identified by it's id.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The id of the object that should be set.
-
Object
The Object that will be modified in the JSON format.
26.7 Remove-anynodeObject
Deletes a object from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The id of the object that should be deleted.
26.8 Remove-anynodeObjects
Deletes a list of objects from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
26.9 Import-anynodeObject
Imports a previously exported object into anynode.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: CloneComment
In case objects are cloned, their name will change to the given comment specified here.
-
bool: ReassignPortOnCollision
If set to true and the imported objects contain a SIP transport object, which ports collide with an existing SIP transport object, the ports will be reassigned automatically.
-
string: Filepath
The path to the file of the objects that should be imported.
-
string: Action
Determines how import objects that already exist in the current config are handled.
Possible values:
-
SKIP
Skip duplicates and only import objects which don't exist in this configuration.
-
OVERRIDE
Overwrite all duplicate objects. Existing objects with the same name as an imported object will be overwritten (Data may be lost).
-
CLONE
Clone all duplicate objects. This means all current objects will be kept.
-
CANCEL
Cancel the import request.
-
26.10 Export-anynodeObject
Exports a object from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: IncludePrivateData
Determines if passwords, private keys and certificates should be included in the exported objects.
-
string: Id
The id of the object that should be exported.