19 Detached Objects

The structure of the objects returned by the functions in this chapter may vary depending on the anynode version.

19.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.

19.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

19.3 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.

19.4 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.

19.5 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.

19.6 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.