Class DmrBridgeService

Hierarchy

  • DmrBridgeService

Constructors

constructor

Methods

createMsgVpnDmrBridge deleteMsgVpnDmrBridge getMsgVpnDmrBridge getMsgVpnDmrBridges replaceMsgVpnDmrBridge updateMsgVpnDmrBridge

Constructors

constructor

Methods

Static createMsgVpnDmrBridge

  • Create a DMR Bridge object. Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    remoteNodeName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.11.

    Returns

    MsgVpnDmrBridgeResponse The DMR Bridge object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnDmrBridge;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnDmrBridge

        The DMR Bridge object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnDmrBridgeResponse | SempMetaOnlyResponse>

Static deleteMsgVpnDmrBridge

  • Delete a DMR Bridge object. Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.11.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          remoteNodeName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • remoteNodeName: string

        The name of the node at the remote end of the DMR Bridge. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnDmrBridge

  • Get a DMR Bridge object. Get a DMR Bridge object.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    remoteNodeName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.11.

    Returns

    MsgVpnDmrBridgeResponse The DMR Bridge object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          remoteNodeName: string;
          select?: string[];
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • remoteNodeName: string

        The name of the node at the remote end of the DMR Bridge. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnDmrBridgeResponse | SempMetaOnlyResponse>

Static getMsgVpnDmrBridges

  • Get a list of DMR Bridge objects. Get a list of DMR Bridge objects.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    remoteNodeName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.11.

    Returns

    MsgVpnDmrBridgesResponse The list of DMR Bridge objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnDmrBridgesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnDmrBridge

  • Replace a DMR Bridge object. Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    remoteNodeName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.11.

    Returns

    MsgVpnDmrBridgeResponse The DMR Bridge object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnDmrBridge;
          msgVpnName: string;
          opaquePassword?: string;
          remoteNodeName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnDmrBridge

        The DMR Bridge object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • remoteNodeName: string

        The name of the node at the remote end of the DMR Bridge. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnDmrBridgeResponse | SempMetaOnlyResponse>

Static updateMsgVpnDmrBridge

  • Update a DMR Bridge object. Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.

    A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    remoteNodeName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.11.

    Returns

    MsgVpnDmrBridgeResponse The DMR Bridge object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnDmrBridge;
          msgVpnName: string;
          opaquePassword?: string;
          remoteNodeName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnDmrBridge

        The DMR Bridge object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • remoteNodeName: string

        The name of the node at the remote end of the DMR Bridge. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnDmrBridgeResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme