Class VirtualHostnameService

Hierarchy

  • VirtualHostnameService

Constructors

constructor

Methods

createVirtualHostname deleteVirtualHostname getVirtualHostname getVirtualHostnames replaceVirtualHostname updateVirtualHostname

Constructors

constructor

Methods

Static createVirtualHostname

  • Create a Virtual Hostname object. Create a Virtual Hostname 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 via config-sync.

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    virtualHostname 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.17.

    Returns

    VirtualHostnameResponse The Virtual Hostname object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Virtual Hostname object's attributes. *

      • 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<SempMetaOnlyResponse | VirtualHostnameResponse>

Static deleteVirtualHostname

  • Delete a Virtual Hostname object. Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync.

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

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

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          virtualHostname: string;
          xContextId?: string;
      }
      • virtualHostname: string

        The virtual hostname. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getVirtualHostname

  • Get a Virtual Hostname object. Get a Virtual Hostname object.

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

    Attribute Identifying Write-Only Deprecated Opaque
    virtualHostname x

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

    This has been available since 2.17.

    Returns

    VirtualHostnameResponse The Virtual Hostname object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          opaquePassword?: string;
          select?: string[];
          virtualHostname: string;
          xContextId?: string;
      }
      • 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. *

      • virtualHostname: string

        The virtual hostname. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse | VirtualHostnameResponse>

Static getVirtualHostnames

  • Get a list of Virtual Hostname objects. Get a list of Virtual Hostname objects.

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

    Attribute Identifying Write-Only Deprecated Opaque
    virtualHostname x

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

    This has been available since 2.17.

    Returns

    VirtualHostnamesResponse The list of Virtual Hostname objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: 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. *

      • 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<SempMetaOnlyResponse | VirtualHostnamesResponse>

Static replaceVirtualHostname

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

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    virtualHostname 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.17.

    Returns

    VirtualHostnameResponse The Virtual Hostname object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: VirtualHostname;
          opaquePassword?: string;
          select?: string[];
          virtualHostname: string;
          xContextId?: string;
      }
      • body: VirtualHostname

        The Virtual Hostname object's attributes. *

      • 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. *

      • virtualHostname: string

        The virtual hostname. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse | VirtualHostnameResponse>

Static updateVirtualHostname

  • Update a Virtual Hostname object. Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged.

    A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.

    Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.

    This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    virtualHostname 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.17.

    Returns

    VirtualHostnameResponse The Virtual Hostname object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: VirtualHostname;
          opaquePassword?: string;
          select?: string[];
          virtualHostname: string;
          xContextId?: string;
      }
      • body: VirtualHostname

        The Virtual Hostname object's attributes. *

      • 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. *

      • virtualHostname: string

        The virtual hostname. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse | VirtualHostnameResponse>

Settings

Member Visibility

Theme