Module solace.semp

xlibb/solace.semp

0.2.0

Ballerina Solace SEMP v2 Connector

This Ballerina module provides a connector for interacting with Solace PubSub+ brokers via the SEMP v2 (Solace Element Management Protocol, version 2) — the REST-based management API for configuring and monitoring Solace message brokers.

With this connector you can programmatically perform broker administrative operations from your Ballerina application: for example, create or configure message VPNs, queues, topic endpoints; monitor queue or topic stats; manage clients; and trigger administrative actions such as message purge or broker HA control — all via SEMP v2’s structured JSON API.

Clients

solace.semp: Client

Isolated

SEMP (starting in v2) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. This specification defines the following API:

API	Base Path	Purpose
Configuration	/SEMP/v2/config	Reading and writing configuration

The following APIs are also available:

API	Base Path	Purpose
Action	/SEMP/v2/action	Performing actions
Monitoring	/SEMP/v2/monitor	Querying operational state

For tutorials, architectural and protocol design documentation, and other information about the SEMP API, consult the SEMP documentation on the Solace website. The SEMP API specifications are also available for download.

If you need additional support, please contact us at support@solace.com.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://www.solace.com/SEMP/v2/config" - URL of the target service

getBroker

Isolated FunctionRemote Function

function getBroker(map<string|string[]> headers, *GetBrokerQueries queries) returns BrokerResponse|error

Get a Broker object.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBrokerQueries - Queries to be sent with the request

Return Type

BrokerResponse|error - The Broker object's attributes, and the request metadata.

updateBroker

Isolated FunctionRemote Function

function updateBroker(Broker payload, map<string|string[]> headers, *UpdateBrokerQueries queries) returns BrokerResponse|error

Update a Broker object.

Parameters

payload Broker - The Broker object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateBrokerQueries - Queries to be sent with the request

Return Type

BrokerResponse|error - The Broker object's attributes after being updated, and the request metadata.

getAbout

Isolated FunctionRemote Function

function getAbout(map<string|string[]> headers, *GetAboutQueries queries) returns AboutResponse|error

Get an About object.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAboutQueries - Queries to be sent with the request

Return Type

AboutResponse|error - The About object's attributes, and the request metadata.

getAboutApi

Isolated FunctionRemote Function

function getAboutApi(map<string|string[]> headers, *GetAboutApiQueries queries) returns AboutApiResponse|error

Get an API Description object.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAboutApiQueries - Queries to be sent with the request

Return Type

AboutApiResponse|error - The API Description object's attributes, and the request metadata.

getAboutUser

Isolated FunctionRemote Function

function getAboutUser(map<string|string[]> headers, *GetAboutUserQueries queries) returns AboutUserResponse|error

Get a User object.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAboutUserQueries - Queries to be sent with the request

Return Type

AboutUserResponse|error - The User object's attributes, and the request metadata.

getAboutUserMsgVpns

Isolated FunctionRemote Function

function getAboutUserMsgVpns(map<string|string[]> headers, *GetAboutUserMsgVpnsQueries queries) returns AboutUserMsgVpnsResponse|error

Get a list of User Message VPN objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAboutUserMsgVpnsQueries - Queries to be sent with the request

Return Type

AboutUserMsgVpnsResponse|error - The list of User Message VPN objects' attributes, and the request metadata.

getAboutUserMsgVpn

Isolated FunctionRemote Function

function getAboutUserMsgVpn(string msgVpnName, map<string|string[]> headers, *GetAboutUserMsgVpnQueries queries) returns AboutUserMsgVpnResponse|error

Get a User Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAboutUserMsgVpnQueries - Queries to be sent with the request

Return Type

AboutUserMsgVpnResponse|error - The User Message VPN object's attributes, and the request metadata.

getCertAuthorities

DeprecatedIsolated FunctionRemote Function

function getCertAuthorities(map<string|string[]> headers, *GetCertAuthoritiesQueries queries) returns CertAuthoritiesResponse|error

Get a list of Certificate Authority objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetCertAuthoritiesQueries - Queries to be sent with the request

Return Type

CertAuthoritiesResponse|error - The list of Certificate Authority objects' attributes, and the request metadata.

Deprecated

createCertAuthority

DeprecatedIsolated FunctionRemote Function

function createCertAuthority(CertAuthority payload, map<string|string[]> headers, *CreateCertAuthorityQueries queries) returns CertAuthorityResponse|error

Create a Certificate Authority object.

Parameters

payload CertAuthority - The Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateCertAuthorityQueries - Queries to be sent with the request

Return Type

CertAuthorityResponse|error - The Certificate Authority object's attributes after being created, and the request metadata.

Deprecated

getCertAuthority

DeprecatedIsolated FunctionRemote Function

function getCertAuthority(string certAuthorityName, map<string|string[]> headers, *GetCertAuthorityQueries queries) returns CertAuthorityResponse|error

Get a Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetCertAuthorityQueries - Queries to be sent with the request

Return Type

CertAuthorityResponse|error - The Certificate Authority object's attributes, and the request metadata.

Deprecated

replaceCertAuthority

DeprecatedIsolated FunctionRemote Function

function replaceCertAuthority(string certAuthorityName, CertAuthority payload, map<string|string[]> headers, *ReplaceCertAuthorityQueries queries) returns CertAuthorityResponse|error

Replace a Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload CertAuthority - The Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceCertAuthorityQueries - Queries to be sent with the request

Return Type

CertAuthorityResponse|error - The Certificate Authority object's attributes after being replaced, and the request metadata.

Deprecated

deleteCertAuthority

DeprecatedIsolated FunctionRemote Function

function deleteCertAuthority(string certAuthorityName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

updateCertAuthority

DeprecatedIsolated FunctionRemote Function

function updateCertAuthority(string certAuthorityName, CertAuthority payload, map<string|string[]> headers, *UpdateCertAuthorityQueries queries) returns CertAuthorityResponse|error

Update a Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload CertAuthority - The Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateCertAuthorityQueries - Queries to be sent with the request

Return Type

CertAuthorityResponse|error - The Certificate Authority object's attributes after being updated, and the request metadata.

Deprecated

getCertAuthorityOcspTlsTrustedCommonNames

DeprecatedIsolated FunctionRemote Function

function getCertAuthorityOcspTlsTrustedCommonNames(string certAuthorityName, map<string|string[]> headers, *GetCertAuthorityOcspTlsTrustedCommonNamesQueries queries) returns CertAuthorityOcspTlsTrustedCommonNamesResponse|error

Get a list of OCSP Responder Trusted Common Name objects.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetCertAuthorityOcspTlsTrustedCommonNamesQueries - Queries to be sent with the request

Return Type

CertAuthorityOcspTlsTrustedCommonNamesResponse|error - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.

Deprecated

createCertAuthorityOcspTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function createCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, CertAuthorityOcspTlsTrustedCommonName payload, map<string|string[]> headers, *CreateCertAuthorityOcspTlsTrustedCommonNameQueries queries) returns CertAuthorityOcspTlsTrustedCommonNameResponse|error

Create an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload CertAuthorityOcspTlsTrustedCommonName - The OCSP Responder Trusted Common Name object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateCertAuthorityOcspTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

CertAuthorityOcspTlsTrustedCommonNameResponse|error - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.

Deprecated

getCertAuthorityOcspTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function getCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, string ocspTlsTrustedCommonName, map<string|string[]> headers, *GetCertAuthorityOcspTlsTrustedCommonNameQueries queries) returns CertAuthorityOcspTlsTrustedCommonNameResponse|error

Get an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

ocspTlsTrustedCommonName string - The expected Trusted Common Name of the OCSP responder remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetCertAuthorityOcspTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

CertAuthorityOcspTlsTrustedCommonNameResponse|error - The OCSP Responder Trusted Common Name object's attributes, and the request metadata.

Deprecated

deleteCertAuthorityOcspTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function deleteCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, string ocspTlsTrustedCommonName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

ocspTlsTrustedCommonName string - The expected Trusted Common Name of the OCSP responder remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getClientCertAuthorities

Isolated FunctionRemote Function

function getClientCertAuthorities(map<string|string[]> headers, *GetClientCertAuthoritiesQueries queries) returns ClientCertAuthoritiesResponse|error

Get a list of Client Certificate Authority objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetClientCertAuthoritiesQueries - Queries to be sent with the request

Return Type

ClientCertAuthoritiesResponse|error - The list of Client Certificate Authority objects' attributes, and the request metadata.

createClientCertAuthority

Isolated FunctionRemote Function

function createClientCertAuthority(ClientCertAuthority payload, map<string|string[]> headers, *CreateClientCertAuthorityQueries queries) returns ClientCertAuthorityResponse|error

Create a Client Certificate Authority object.

Parameters

payload ClientCertAuthority - The Client Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateClientCertAuthorityQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityResponse|error - The Client Certificate Authority object's attributes after being created, and the request metadata.

getClientCertAuthority

Isolated FunctionRemote Function

function getClientCertAuthority(string certAuthorityName, map<string|string[]> headers, *GetClientCertAuthorityQueries queries) returns ClientCertAuthorityResponse|error

Get a Client Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetClientCertAuthorityQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityResponse|error - The Client Certificate Authority object's attributes, and the request metadata.

replaceClientCertAuthority

Isolated FunctionRemote Function

function replaceClientCertAuthority(string certAuthorityName, ClientCertAuthority payload, map<string|string[]> headers, *ReplaceClientCertAuthorityQueries queries) returns ClientCertAuthorityResponse|error

Replace a Client Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload ClientCertAuthority - The Client Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceClientCertAuthorityQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityResponse|error - The Client Certificate Authority object's attributes after being replaced, and the request metadata.

deleteClientCertAuthority

Isolated FunctionRemote Function

function deleteClientCertAuthority(string certAuthorityName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Client Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateClientCertAuthority

Isolated FunctionRemote Function

function updateClientCertAuthority(string certAuthorityName, ClientCertAuthority payload, map<string|string[]> headers, *UpdateClientCertAuthorityQueries queries) returns ClientCertAuthorityResponse|error

Update a Client Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload ClientCertAuthority - The Client Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateClientCertAuthorityQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityResponse|error - The Client Certificate Authority object's attributes after being updated, and the request metadata.

getClientCertAuthorityOcspTlsTrustedCommonNames

Isolated FunctionRemote Function

function getClientCertAuthorityOcspTlsTrustedCommonNames(string certAuthorityName, map<string|string[]> headers, *GetClientCertAuthorityOcspTlsTrustedCommonNamesQueries queries) returns ClientCertAuthorityOcspTlsTrustedCommonNamesResponse|error

Get a list of OCSP Responder Trusted Common Name objects.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetClientCertAuthorityOcspTlsTrustedCommonNamesQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityOcspTlsTrustedCommonNamesResponse|error - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.

createClientCertAuthorityOcspTlsTrustedCommonName

Isolated FunctionRemote Function

function createClientCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, ClientCertAuthorityOcspTlsTrustedCommonName payload, map<string|string[]> headers, *CreateClientCertAuthorityOcspTlsTrustedCommonNameQueries queries) returns ClientCertAuthorityOcspTlsTrustedCommonNameResponse|error

Create an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload ClientCertAuthorityOcspTlsTrustedCommonName - The OCSP Responder Trusted Common Name object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateClientCertAuthorityOcspTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityOcspTlsTrustedCommonNameResponse|error - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.

getClientCertAuthorityOcspTlsTrustedCommonName

Isolated FunctionRemote Function

function getClientCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, string ocspTlsTrustedCommonName, map<string|string[]> headers, *GetClientCertAuthorityOcspTlsTrustedCommonNameQueries queries) returns ClientCertAuthorityOcspTlsTrustedCommonNameResponse|error

Get an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

ocspTlsTrustedCommonName string - The expected Trusted Common Name of the OCSP responder remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetClientCertAuthorityOcspTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

ClientCertAuthorityOcspTlsTrustedCommonNameResponse|error - The OCSP Responder Trusted Common Name object's attributes, and the request metadata.

deleteClientCertAuthorityOcspTlsTrustedCommonName

Isolated FunctionRemote Function

function deleteClientCertAuthorityOcspTlsTrustedCommonName(string certAuthorityName, string ocspTlsTrustedCommonName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an OCSP Responder Trusted Common Name object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

ocspTlsTrustedCommonName string - The expected Trusted Common Name of the OCSP responder remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getDmrClusters

Isolated FunctionRemote Function

function getDmrClusters(map<string|string[]> headers, *GetDmrClustersQueries queries) returns DmrClustersResponse|error

Get a list of Cluster objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClustersQueries - Queries to be sent with the request

Return Type

DmrClustersResponse|error - The list of Cluster objects' attributes, and the request metadata.

createDmrCluster

Isolated FunctionRemote Function

function createDmrCluster(DmrCluster payload, map<string|string[]> headers, *CreateDmrClusterQueries queries) returns DmrClusterResponse|error

Create a Cluster object.

Parameters

payload DmrCluster - The Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterQueries - Queries to be sent with the request

Return Type

DmrClusterResponse|error - The Cluster object's attributes after being created, and the request metadata.

getDmrCluster

Isolated FunctionRemote Function

function getDmrCluster(string dmrClusterName, map<string|string[]> headers, *GetDmrClusterQueries queries) returns DmrClusterResponse|error

Get a Cluster object.

Parameters

dmrClusterName string - The name of the Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterQueries - Queries to be sent with the request

Return Type

DmrClusterResponse|error - The Cluster object's attributes, and the request metadata.

replaceDmrCluster

Isolated FunctionRemote Function

function replaceDmrCluster(string dmrClusterName, DmrCluster payload, map<string|string[]> headers, *ReplaceDmrClusterQueries queries) returns DmrClusterResponse|error

Replace a Cluster object.

Parameters

dmrClusterName string - The name of the Cluster.

payload DmrCluster - The Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceDmrClusterQueries - Queries to be sent with the request

Return Type

DmrClusterResponse|error - The Cluster object's attributes after being replaced, and the request metadata.

deleteDmrCluster

Isolated FunctionRemote Function

function deleteDmrCluster(string dmrClusterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Cluster object.

Parameters

dmrClusterName string - The name of the Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateDmrCluster

Isolated FunctionRemote Function

function updateDmrCluster(string dmrClusterName, DmrCluster payload, map<string|string[]> headers, *UpdateDmrClusterQueries queries) returns DmrClusterResponse|error

Update a Cluster object.

Parameters

dmrClusterName string - The name of the Cluster.

payload DmrCluster - The Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateDmrClusterQueries - Queries to be sent with the request

Return Type

DmrClusterResponse|error - The Cluster object's attributes after being updated, and the request metadata.

getDmrClusterCertMatchingRules

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRules(string dmrClusterName, map<string|string[]> headers, *GetDmrClusterCertMatchingRulesQueries queries) returns DmrClusterCertMatchingRulesResponse|error

Get a list of Certificate Matching Rule objects.

Parameters

dmrClusterName string - The name of the Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRulesQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRulesResponse|error - The list of Certificate Matching Rule objects' attributes, and the request metadata.

createDmrClusterCertMatchingRule

Isolated FunctionRemote Function

function createDmrClusterCertMatchingRule(string dmrClusterName, DmrClusterCertMatchingRule payload, map<string|string[]> headers, *CreateDmrClusterCertMatchingRuleQueries queries) returns DmrClusterCertMatchingRuleResponse|error

Create a Certificate Matching Rule object.

Parameters

dmrClusterName string - The name of the Cluster.

payload DmrClusterCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterCertMatchingRuleQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being created, and the request metadata.

getDmrClusterCertMatchingRule

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRule(string dmrClusterName, string ruleName, map<string|string[]> headers, *GetDmrClusterCertMatchingRuleQueries queries) returns DmrClusterCertMatchingRuleResponse|error

Get a Certificate Matching Rule object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRuleQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes, and the request metadata.

replaceDmrClusterCertMatchingRule

Isolated FunctionRemote Function

function replaceDmrClusterCertMatchingRule(string dmrClusterName, string ruleName, DmrClusterCertMatchingRule payload, map<string|string[]> headers, *ReplaceDmrClusterCertMatchingRuleQueries queries) returns DmrClusterCertMatchingRuleResponse|error

Replace a Certificate Matching Rule object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

payload DmrClusterCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceDmrClusterCertMatchingRuleQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being replaced, and the request metadata.

deleteDmrClusterCertMatchingRule

Isolated FunctionRemote Function

function deleteDmrClusterCertMatchingRule(string dmrClusterName, string ruleName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateDmrClusterCertMatchingRule

Isolated FunctionRemote Function

function updateDmrClusterCertMatchingRule(string dmrClusterName, string ruleName, DmrClusterCertMatchingRule payload, map<string|string[]> headers, *UpdateDmrClusterCertMatchingRuleQueries queries) returns DmrClusterCertMatchingRuleResponse|error

Update a Certificate Matching Rule object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

payload DmrClusterCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateDmrClusterCertMatchingRuleQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being updated, and the request metadata.

getDmrClusterCertMatchingRuleAttributeFilters

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRuleAttributeFilters(string dmrClusterName, string ruleName, map<string|string[]> headers, *GetDmrClusterCertMatchingRuleAttributeFiltersQueries queries) returns DmrClusterCertMatchingRuleAttributeFiltersResponse|error

Get a list of Certificate Matching Rule Attribute Filter objects.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRuleAttributeFiltersQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleAttributeFiltersResponse|error - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.

createDmrClusterCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function createDmrClusterCertMatchingRuleAttributeFilter(string dmrClusterName, string ruleName, DmrClusterCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *CreateDmrClusterCertMatchingRuleAttributeFilterQueries queries) returns DmrClusterCertMatchingRuleAttributeFilterResponse|error

Create a Certificate Matching Rule Attribute Filter object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

payload DmrClusterCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.

getDmrClusterCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRuleAttributeFilter(string dmrClusterName, string ruleName, string filterName, map<string|string[]> headers, *GetDmrClusterCertMatchingRuleAttributeFilterQueries queries) returns DmrClusterCertMatchingRuleAttributeFilterResponse|error

Get a Certificate Matching Rule Attribute Filter object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

filterName string - The name of the filter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.

replaceDmrClusterCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function replaceDmrClusterCertMatchingRuleAttributeFilter(string dmrClusterName, string ruleName, string filterName, DmrClusterCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *ReplaceDmrClusterCertMatchingRuleAttributeFilterQueries queries) returns DmrClusterCertMatchingRuleAttributeFilterResponse|error

Replace a Certificate Matching Rule Attribute Filter object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

filterName string - The name of the filter.

payload DmrClusterCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceDmrClusterCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.

deleteDmrClusterCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function deleteDmrClusterCertMatchingRuleAttributeFilter(string dmrClusterName, string ruleName, string filterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule Attribute Filter object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

filterName string - The name of the filter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateDmrClusterCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function updateDmrClusterCertMatchingRuleAttributeFilter(string dmrClusterName, string ruleName, string filterName, DmrClusterCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *UpdateDmrClusterCertMatchingRuleAttributeFilterQueries queries) returns DmrClusterCertMatchingRuleAttributeFilterResponse|error

Update a Certificate Matching Rule Attribute Filter object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

filterName string - The name of the filter.

payload DmrClusterCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateDmrClusterCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.

getDmrClusterCertMatchingRuleConditions

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRuleConditions(string dmrClusterName, string ruleName, map<string|string[]> headers, *GetDmrClusterCertMatchingRuleConditionsQueries queries) returns DmrClusterCertMatchingRuleConditionsResponse|error

Get a list of Certificate Matching Rule Condition objects.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRuleConditionsQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleConditionsResponse|error - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.

createDmrClusterCertMatchingRuleCondition

Isolated FunctionRemote Function

function createDmrClusterCertMatchingRuleCondition(string dmrClusterName, string ruleName, DmrClusterCertMatchingRuleCondition payload, map<string|string[]> headers, *CreateDmrClusterCertMatchingRuleConditionQueries queries) returns DmrClusterCertMatchingRuleConditionResponse|error

Create a Certificate Matching Rule Condition object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

payload DmrClusterCertMatchingRuleCondition - The Certificate Matching Rule Condition object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterCertMatchingRuleConditionQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleConditionResponse|error - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.

getDmrClusterCertMatchingRuleCondition

Isolated FunctionRemote Function

function getDmrClusterCertMatchingRuleCondition(string dmrClusterName, string ruleName, string 'source, map<string|string[]> headers, *GetDmrClusterCertMatchingRuleConditionQueries queries) returns DmrClusterCertMatchingRuleConditionResponse|error

Get a Certificate Matching Rule Condition object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

'source string - Certificate field to be compared with the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterCertMatchingRuleConditionQueries - Queries to be sent with the request

Return Type

DmrClusterCertMatchingRuleConditionResponse|error - The Certificate Matching Rule Condition object's attributes, and the request metadata.

deleteDmrClusterCertMatchingRuleCondition

Isolated FunctionRemote Function

function deleteDmrClusterCertMatchingRuleCondition(string dmrClusterName, string ruleName, string 'source, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule Condition object.

Parameters

dmrClusterName string - The name of the Cluster.

ruleName string - The name of the rule.

'source string - Certificate field to be compared with the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getDmrClusterLinks

Isolated FunctionRemote Function

function getDmrClusterLinks(string dmrClusterName, map<string|string[]> headers, *GetDmrClusterLinksQueries queries) returns DmrClusterLinksResponse|error

Get a list of Link objects.

Parameters

dmrClusterName string - The name of the Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinksQueries - Queries to be sent with the request

Return Type

DmrClusterLinksResponse|error - The list of Link objects' attributes, and the request metadata.

createDmrClusterLink

Isolated FunctionRemote Function

function createDmrClusterLink(string dmrClusterName, DmrClusterLink payload, map<string|string[]> headers, *CreateDmrClusterLinkQueries queries) returns DmrClusterLinkResponse|error

Create a Link object.

Parameters

dmrClusterName string - The name of the Cluster.

payload DmrClusterLink - The Link object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterLinkQueries - Queries to be sent with the request

Return Type

DmrClusterLinkResponse|error - The Link object's attributes after being created, and the request metadata.

getDmrClusterLink

Isolated FunctionRemote Function

function getDmrClusterLink(string dmrClusterName, string remoteNodeName, map<string|string[]> headers, *GetDmrClusterLinkQueries queries) returns DmrClusterLinkResponse|error

Get a Link object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkQueries - Queries to be sent with the request

Return Type

DmrClusterLinkResponse|error - The Link object's attributes, and the request metadata.

replaceDmrClusterLink

Isolated FunctionRemote Function

function replaceDmrClusterLink(string dmrClusterName, string remoteNodeName, DmrClusterLink payload, map<string|string[]> headers, *ReplaceDmrClusterLinkQueries queries) returns DmrClusterLinkResponse|error

Replace a Link object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

payload DmrClusterLink - The Link object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceDmrClusterLinkQueries - Queries to be sent with the request

Return Type

DmrClusterLinkResponse|error - The Link object's attributes after being replaced, and the request metadata.

deleteDmrClusterLink

Isolated FunctionRemote Function

function deleteDmrClusterLink(string dmrClusterName, string remoteNodeName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Link object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateDmrClusterLink

Isolated FunctionRemote Function

function updateDmrClusterLink(string dmrClusterName, string remoteNodeName, DmrClusterLink payload, map<string|string[]> headers, *UpdateDmrClusterLinkQueries queries) returns DmrClusterLinkResponse|error

Update a Link object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

payload DmrClusterLink - The Link object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateDmrClusterLinkQueries - Queries to be sent with the request

Return Type

DmrClusterLinkResponse|error - The Link object's attributes after being updated, and the request metadata.

getDmrClusterLinkAttributes

Isolated FunctionRemote Function

function getDmrClusterLinkAttributes(string dmrClusterName, string remoteNodeName, map<string|string[]> headers, *GetDmrClusterLinkAttributesQueries queries) returns DmrClusterLinkAttributesResponse|error

Get a list of Link Attribute objects.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkAttributesQueries - Queries to be sent with the request

Return Type

DmrClusterLinkAttributesResponse|error - The list of Link Attribute objects' attributes, and the request metadata.

createDmrClusterLinkAttribute

Isolated FunctionRemote Function

function createDmrClusterLinkAttribute(string dmrClusterName, string remoteNodeName, DmrClusterLinkAttribute payload, map<string|string[]> headers, *CreateDmrClusterLinkAttributeQueries queries) returns DmrClusterLinkAttributeResponse|error

Create a Link Attribute object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

payload DmrClusterLinkAttribute - The Link Attribute object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterLinkAttributeQueries - Queries to be sent with the request

Return Type

DmrClusterLinkAttributeResponse|error - The Link Attribute object's attributes after being created, and the request metadata.

getDmrClusterLinkAttribute

Isolated FunctionRemote Function

function getDmrClusterLinkAttribute(string dmrClusterName, string remoteNodeName, string attributeName, string attributeValue, map<string|string[]> headers, *GetDmrClusterLinkAttributeQueries queries) returns DmrClusterLinkAttributeResponse|error

Get a Link Attribute object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

attributeName string - The name of the Attribute.

attributeValue string - The value of the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkAttributeQueries - Queries to be sent with the request

Return Type

DmrClusterLinkAttributeResponse|error - The Link Attribute object's attributes, and the request metadata.

deleteDmrClusterLinkAttribute

Isolated FunctionRemote Function

function deleteDmrClusterLinkAttribute(string dmrClusterName, string remoteNodeName, string attributeName, string attributeValue, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Link Attribute object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

attributeName string - The name of the Attribute.

attributeValue string - The value of the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getDmrClusterLinkRemoteAddresses

Isolated FunctionRemote Function

function getDmrClusterLinkRemoteAddresses(string dmrClusterName, string remoteNodeName, map<string|string[]> headers, *GetDmrClusterLinkRemoteAddressesQueries queries) returns DmrClusterLinkRemoteAddressesResponse|error

Get a list of Remote Address objects.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkRemoteAddressesQueries - Queries to be sent with the request

Return Type

DmrClusterLinkRemoteAddressesResponse|error - The list of Remote Address objects' attributes, and the request metadata.

createDmrClusterLinkRemoteAddress

Isolated FunctionRemote Function

function createDmrClusterLinkRemoteAddress(string dmrClusterName, string remoteNodeName, DmrClusterLinkRemoteAddress payload, map<string|string[]> headers, *CreateDmrClusterLinkRemoteAddressQueries queries) returns DmrClusterLinkRemoteAddressResponse|error

Create a Remote Address object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

payload DmrClusterLinkRemoteAddress - The Remote Address object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterLinkRemoteAddressQueries - Queries to be sent with the request

Return Type

DmrClusterLinkRemoteAddressResponse|error - The Remote Address object's attributes after being created, and the request metadata.

getDmrClusterLinkRemoteAddress

Isolated FunctionRemote Function

function getDmrClusterLinkRemoteAddress(string dmrClusterName, string remoteNodeName, string remoteAddress, map<string|string[]> headers, *GetDmrClusterLinkRemoteAddressQueries queries) returns DmrClusterLinkRemoteAddressResponse|error

Get a Remote Address object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

remoteAddress string - The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkRemoteAddressQueries - Queries to be sent with the request

Return Type

DmrClusterLinkRemoteAddressResponse|error - The Remote Address object's attributes, and the request metadata.

deleteDmrClusterLinkRemoteAddress

Isolated FunctionRemote Function

function deleteDmrClusterLinkRemoteAddress(string dmrClusterName, string remoteNodeName, string remoteAddress, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Remote Address object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

remoteAddress string - The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getDmrClusterLinkTlsTrustedCommonNames

DeprecatedIsolated FunctionRemote Function

function getDmrClusterLinkTlsTrustedCommonNames(string dmrClusterName, string remoteNodeName, map<string|string[]> headers, *GetDmrClusterLinkTlsTrustedCommonNamesQueries queries) returns DmrClusterLinkTlsTrustedCommonNamesResponse|error

Get a list of Trusted Common Name objects.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkTlsTrustedCommonNamesQueries - Queries to be sent with the request

Return Type

DmrClusterLinkTlsTrustedCommonNamesResponse|error - The list of Trusted Common Name objects' attributes, and the request metadata.

Deprecated

createDmrClusterLinkTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function createDmrClusterLinkTlsTrustedCommonName(string dmrClusterName, string remoteNodeName, DmrClusterLinkTlsTrustedCommonName payload, map<string|string[]> headers, *CreateDmrClusterLinkTlsTrustedCommonNameQueries queries) returns DmrClusterLinkTlsTrustedCommonNameResponse|error

Create a Trusted Common Name object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

payload DmrClusterLinkTlsTrustedCommonName - The Trusted Common Name object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDmrClusterLinkTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

DmrClusterLinkTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes after being created, and the request metadata.

Deprecated

getDmrClusterLinkTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function getDmrClusterLinkTlsTrustedCommonName(string dmrClusterName, string remoteNodeName, string tlsTrustedCommonName, map<string|string[]> headers, *GetDmrClusterLinkTlsTrustedCommonNameQueries queries) returns DmrClusterLinkTlsTrustedCommonNameResponse|error

Get a Trusted Common Name object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDmrClusterLinkTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

DmrClusterLinkTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes, and the request metadata.

Deprecated

deleteDmrClusterLinkTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function deleteDmrClusterLinkTlsTrustedCommonName(string dmrClusterName, string remoteNodeName, string tlsTrustedCommonName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Trusted Common Name object.

Parameters

dmrClusterName string - The name of the Cluster.

remoteNodeName string - The name of the node at the remote end of the Link.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getDomainCertAuthorities

Isolated FunctionRemote Function

function getDomainCertAuthorities(map<string|string[]> headers, *GetDomainCertAuthoritiesQueries queries) returns DomainCertAuthoritiesResponse|error

Get a list of Domain Certificate Authority objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDomainCertAuthoritiesQueries - Queries to be sent with the request

Return Type

DomainCertAuthoritiesResponse|error - The list of Domain Certificate Authority objects' attributes, and the request metadata.

createDomainCertAuthority

Isolated FunctionRemote Function

function createDomainCertAuthority(DomainCertAuthority payload, map<string|string[]> headers, *CreateDomainCertAuthorityQueries queries) returns DomainCertAuthorityResponse|error

Create a Domain Certificate Authority object.

Parameters

payload DomainCertAuthority - The Domain Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDomainCertAuthorityQueries - Queries to be sent with the request

Return Type

DomainCertAuthorityResponse|error - The Domain Certificate Authority object's attributes after being created, and the request metadata.

getDomainCertAuthority

Isolated FunctionRemote Function

function getDomainCertAuthority(string certAuthorityName, map<string|string[]> headers, *GetDomainCertAuthorityQueries queries) returns DomainCertAuthorityResponse|error

Get a Domain Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDomainCertAuthorityQueries - Queries to be sent with the request

Return Type

DomainCertAuthorityResponse|error - The Domain Certificate Authority object's attributes, and the request metadata.

replaceDomainCertAuthority

Isolated FunctionRemote Function

function replaceDomainCertAuthority(string certAuthorityName, DomainCertAuthority payload, map<string|string[]> headers, *ReplaceDomainCertAuthorityQueries queries) returns DomainCertAuthorityResponse|error

Replace a Domain Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload DomainCertAuthority - The Domain Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceDomainCertAuthorityQueries - Queries to be sent with the request

Return Type

DomainCertAuthorityResponse|error - The Domain Certificate Authority object's attributes after being replaced, and the request metadata.

deleteDomainCertAuthority

Isolated FunctionRemote Function

function deleteDomainCertAuthority(string certAuthorityName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Domain Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateDomainCertAuthority

Isolated FunctionRemote Function

function updateDomainCertAuthority(string certAuthorityName, DomainCertAuthority payload, map<string|string[]> headers, *UpdateDomainCertAuthorityQueries queries) returns DomainCertAuthorityResponse|error

Update a Domain Certificate Authority object.

Parameters

certAuthorityName string - The name of the Certificate Authority.

payload DomainCertAuthority - The Domain Certificate Authority object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateDomainCertAuthorityQueries - Queries to be sent with the request

Return Type

DomainCertAuthorityResponse|error - The Domain Certificate Authority object's attributes after being updated, and the request metadata.

getMsgVpns

Isolated FunctionRemote Function

function getMsgVpns(map<string|string[]> headers, *GetMsgVpnsQueries queries) returns MsgVpnsResponse|error

Get a list of Message VPN objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnsQueries - Queries to be sent with the request

Return Type

MsgVpnsResponse|error - The list of Message VPN objects' attributes, and the request metadata.

createMsgVpn

Isolated FunctionRemote Function

function createMsgVpn(MsgVpn payload, map<string|string[]> headers, *CreateMsgVpnQueries queries) returns MsgVpnResponse|error

Create a Message VPN object.

Parameters

payload MsgVpn - The Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnResponse|error - The Message VPN object's attributes after being created, and the request metadata.

getMsgVpn

Isolated FunctionRemote Function

function getMsgVpn(string msgVpnName, map<string|string[]> headers, *GetMsgVpnQueries queries) returns MsgVpnResponse|error

Get a Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnResponse|error - The Message VPN object's attributes, and the request metadata.

replaceMsgVpn

Isolated FunctionRemote Function

function replaceMsgVpn(string msgVpnName, MsgVpn payload, map<string|string[]> headers, *ReplaceMsgVpnQueries queries) returns MsgVpnResponse|error

Replace a Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpn - The Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnResponse|error - The Message VPN object's attributes after being replaced, and the request metadata.

deleteMsgVpn

Isolated FunctionRemote Function

function deleteMsgVpn(string msgVpnName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpn

Isolated FunctionRemote Function

function updateMsgVpn(string msgVpnName, MsgVpn payload, map<string|string[]> headers, *UpdateMsgVpnQueries queries) returns MsgVpnResponse|error

Update a Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpn - The Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnResponse|error - The Message VPN object's attributes after being updated, and the request metadata.

getMsgVpnAclProfiles

Isolated FunctionRemote Function

function getMsgVpnAclProfiles(string msgVpnName, map<string|string[]> headers, *GetMsgVpnAclProfilesQueries queries) returns MsgVpnAclProfilesResponse|error

Get a list of ACL Profile objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfilesQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilesResponse|error - The list of ACL Profile objects' attributes, and the request metadata.

createMsgVpnAclProfile

Isolated FunctionRemote Function

function createMsgVpnAclProfile(string msgVpnName, MsgVpnAclProfile payload, map<string|string[]> headers, *CreateMsgVpnAclProfileQueries queries) returns MsgVpnAclProfileResponse|error

Create an ACL Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnAclProfile - The ACL Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileResponse|error - The ACL Profile object's attributes after being created, and the request metadata.

getMsgVpnAclProfile

Isolated FunctionRemote Function

function getMsgVpnAclProfile(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfileQueries queries) returns MsgVpnAclProfileResponse|error

Get an ACL Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileResponse|error - The ACL Profile object's attributes, and the request metadata.

replaceMsgVpnAclProfile

Isolated FunctionRemote Function

function replaceMsgVpnAclProfile(string msgVpnName, string aclProfileName, MsgVpnAclProfile payload, map<string|string[]> headers, *ReplaceMsgVpnAclProfileQueries queries) returns MsgVpnAclProfileResponse|error

Replace an ACL Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfile - The ACL Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnAclProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileResponse|error - The ACL Profile object's attributes after being replaced, and the request metadata.

deleteMsgVpnAclProfile

Isolated FunctionRemote Function

function deleteMsgVpnAclProfile(string msgVpnName, string aclProfileName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an ACL Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnAclProfile

Isolated FunctionRemote Function

function updateMsgVpnAclProfile(string msgVpnName, string aclProfileName, MsgVpnAclProfile payload, map<string|string[]> headers, *UpdateMsgVpnAclProfileQueries queries) returns MsgVpnAclProfileResponse|error

Update an ACL Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfile - The ACL Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnAclProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileResponse|error - The ACL Profile object's attributes after being updated, and the request metadata.

getMsgVpnAclProfileClientConnectExceptions

Isolated FunctionRemote Function

function getMsgVpnAclProfileClientConnectExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfileClientConnectExceptionsQueries queries) returns MsgVpnAclProfileClientConnectExceptionsResponse|error

Get a list of Client Connect Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileClientConnectExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileClientConnectExceptionsResponse|error - The list of Client Connect Exception objects' attributes, and the request metadata.

createMsgVpnAclProfileClientConnectException

Isolated FunctionRemote Function

function createMsgVpnAclProfileClientConnectException(string msgVpnName, string aclProfileName, MsgVpnAclProfileClientConnectException payload, map<string|string[]> headers, *CreateMsgVpnAclProfileClientConnectExceptionQueries queries) returns MsgVpnAclProfileClientConnectExceptionResponse|error

Create a Client Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfileClientConnectException - The Client Connect Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfileClientConnectExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileClientConnectExceptionResponse|error - The Client Connect Exception object's attributes after being created, and the request metadata.

getMsgVpnAclProfileClientConnectException

Isolated FunctionRemote Function

function getMsgVpnAclProfileClientConnectException(string msgVpnName, string aclProfileName, string clientConnectExceptionAddress, map<string|string[]> headers, *GetMsgVpnAclProfileClientConnectExceptionQueries queries) returns MsgVpnAclProfileClientConnectExceptionResponse|error

Get a Client Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

clientConnectExceptionAddress string - The IP address/netmask of the client connect exception in canonical CIDR form.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileClientConnectExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileClientConnectExceptionResponse|error - The Client Connect Exception object's attributes, and the request metadata.

deleteMsgVpnAclProfileClientConnectException

Isolated FunctionRemote Function

function deleteMsgVpnAclProfileClientConnectException(string msgVpnName, string aclProfileName, string clientConnectExceptionAddress, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Client Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

clientConnectExceptionAddress string - The IP address/netmask of the client connect exception in canonical CIDR form.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAclProfilePublishExceptions

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAclProfilePublishExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfilePublishExceptionsQueries queries) returns MsgVpnAclProfilePublishExceptionsResponse|error

Get a list of Publish Topic Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfilePublishExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishExceptionsResponse|error - The list of Publish Topic Exception objects' attributes, and the request metadata.

Deprecated

createMsgVpnAclProfilePublishException

DeprecatedIsolated FunctionRemote Function

function createMsgVpnAclProfilePublishException(string msgVpnName, string aclProfileName, MsgVpnAclProfilePublishException payload, map<string|string[]> headers, *CreateMsgVpnAclProfilePublishExceptionQueries queries) returns MsgVpnAclProfilePublishExceptionResponse|error

Create a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfilePublishException - The Publish Topic Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfilePublishExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishExceptionResponse|error - The Publish Topic Exception object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnAclProfilePublishException

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAclProfilePublishException(string msgVpnName, string aclProfileName, string topicSyntax, string publishExceptionTopic, map<string|string[]> headers, *GetMsgVpnAclProfilePublishExceptionQueries queries) returns MsgVpnAclProfilePublishExceptionResponse|error

Get a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

topicSyntax string - The syntax of the topic for the exception to the default action taken.

publishExceptionTopic string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfilePublishExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishExceptionResponse|error - The Publish Topic Exception object's attributes, and the request metadata.

Deprecated

deleteMsgVpnAclProfilePublishException

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnAclProfilePublishException(string msgVpnName, string aclProfileName, string topicSyntax, string publishExceptionTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

topicSyntax string - The syntax of the topic for the exception to the default action taken.

publishExceptionTopic string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getMsgVpnAclProfilePublishTopicExceptions

Isolated FunctionRemote Function

function getMsgVpnAclProfilePublishTopicExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfilePublishTopicExceptionsQueries queries) returns MsgVpnAclProfilePublishTopicExceptionsResponse|error

Get a list of Publish Topic Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfilePublishTopicExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishTopicExceptionsResponse|error - The list of Publish Topic Exception objects' attributes, and the request metadata.

createMsgVpnAclProfilePublishTopicException

Isolated FunctionRemote Function

function createMsgVpnAclProfilePublishTopicException(string msgVpnName, string aclProfileName, MsgVpnAclProfilePublishTopicException payload, map<string|string[]> headers, *CreateMsgVpnAclProfilePublishTopicExceptionQueries queries) returns MsgVpnAclProfilePublishTopicExceptionResponse|error

Create a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfilePublishTopicException - The Publish Topic Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfilePublishTopicExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishTopicExceptionResponse|error - The Publish Topic Exception object's attributes after being created, and the request metadata.

getMsgVpnAclProfilePublishTopicException

Isolated FunctionRemote Function

function getMsgVpnAclProfilePublishTopicException(string msgVpnName, string aclProfileName, string publishTopicExceptionSyntax, string publishTopicException, map<string|string[]> headers, *GetMsgVpnAclProfilePublishTopicExceptionQueries queries) returns MsgVpnAclProfilePublishTopicExceptionResponse|error

Get a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

publishTopicExceptionSyntax string - The syntax of the topic for the exception to the default action taken.

publishTopicException string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfilePublishTopicExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfilePublishTopicExceptionResponse|error - The Publish Topic Exception object's attributes, and the request metadata.

deleteMsgVpnAclProfilePublishTopicException

Isolated FunctionRemote Function

function deleteMsgVpnAclProfilePublishTopicException(string msgVpnName, string aclProfileName, string publishTopicExceptionSyntax, string publishTopicException, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Publish Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

publishTopicExceptionSyntax string - The syntax of the topic for the exception to the default action taken.

publishTopicException string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAclProfileSubscribeExceptions

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeExceptionsQueries queries) returns MsgVpnAclProfileSubscribeExceptionsResponse|error

Get a list of Subscribe Topic Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeExceptionsResponse|error - The list of Subscribe Topic Exception objects' attributes, and the request metadata.

Deprecated

createMsgVpnAclProfileSubscribeException

DeprecatedIsolated FunctionRemote Function

function createMsgVpnAclProfileSubscribeException(string msgVpnName, string aclProfileName, MsgVpnAclProfileSubscribeException payload, map<string|string[]> headers, *CreateMsgVpnAclProfileSubscribeExceptionQueries queries) returns MsgVpnAclProfileSubscribeExceptionResponse|error

Create a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfileSubscribeException - The Subscribe Topic Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfileSubscribeExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeExceptionResponse|error - The Subscribe Topic Exception object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnAclProfileSubscribeException

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeException(string msgVpnName, string aclProfileName, string topicSyntax, string subscribeExceptionTopic, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeExceptionQueries queries) returns MsgVpnAclProfileSubscribeExceptionResponse|error

Get a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

topicSyntax string - The syntax of the topic for the exception to the default action taken.

subscribeExceptionTopic string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeExceptionResponse|error - The Subscribe Topic Exception object's attributes, and the request metadata.

Deprecated

deleteMsgVpnAclProfileSubscribeException

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnAclProfileSubscribeException(string msgVpnName, string aclProfileName, string topicSyntax, string subscribeExceptionTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

topicSyntax string - The syntax of the topic for the exception to the default action taken.

subscribeExceptionTopic string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getMsgVpnAclProfileSubscribeShareNameExceptions

Isolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeShareNameExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeShareNameExceptionsQueries queries) returns MsgVpnAclProfileSubscribeShareNameExceptionsResponse|error

Get a list of Subscribe Share Name Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeShareNameExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeShareNameExceptionsResponse|error - The list of Subscribe Share Name Exception objects' attributes, and the request metadata.

createMsgVpnAclProfileSubscribeShareNameException

Isolated FunctionRemote Function

function createMsgVpnAclProfileSubscribeShareNameException(string msgVpnName, string aclProfileName, MsgVpnAclProfileSubscribeShareNameException payload, map<string|string[]> headers, *CreateMsgVpnAclProfileSubscribeShareNameExceptionQueries queries) returns MsgVpnAclProfileSubscribeShareNameExceptionResponse|error

Create a Subscribe Share Name Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfileSubscribeShareNameException - The Subscribe Share Name Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfileSubscribeShareNameExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeShareNameExceptionResponse|error - The Subscribe Share Name Exception object's attributes after being created, and the request metadata.

getMsgVpnAclProfileSubscribeShareNameException

Isolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeShareNameException(string msgVpnName, string aclProfileName, string subscribeShareNameExceptionSyntax, string subscribeShareNameException, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeShareNameExceptionQueries queries) returns MsgVpnAclProfileSubscribeShareNameExceptionResponse|error

Get a Subscribe Share Name Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

subscribeShareNameExceptionSyntax string - The syntax of the subscribe share name for the exception to the default action taken.

subscribeShareNameException string - The subscribe share name exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeShareNameExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeShareNameExceptionResponse|error - The Subscribe Share Name Exception object's attributes, and the request metadata.

deleteMsgVpnAclProfileSubscribeShareNameException

Isolated FunctionRemote Function

function deleteMsgVpnAclProfileSubscribeShareNameException(string msgVpnName, string aclProfileName, string subscribeShareNameExceptionSyntax, string subscribeShareNameException, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Subscribe Share Name Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

subscribeShareNameExceptionSyntax string - The syntax of the subscribe share name for the exception to the default action taken.

subscribeShareNameException string - The subscribe share name exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAclProfileSubscribeTopicExceptions

Isolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeTopicExceptions(string msgVpnName, string aclProfileName, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeTopicExceptionsQueries queries) returns MsgVpnAclProfileSubscribeTopicExceptionsResponse|error

Get a list of Subscribe Topic Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeTopicExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeTopicExceptionsResponse|error - The list of Subscribe Topic Exception objects' attributes, and the request metadata.

createMsgVpnAclProfileSubscribeTopicException

Isolated FunctionRemote Function

function createMsgVpnAclProfileSubscribeTopicException(string msgVpnName, string aclProfileName, MsgVpnAclProfileSubscribeTopicException payload, map<string|string[]> headers, *CreateMsgVpnAclProfileSubscribeTopicExceptionQueries queries) returns MsgVpnAclProfileSubscribeTopicExceptionResponse|error

Create a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

payload MsgVpnAclProfileSubscribeTopicException - The Subscribe Topic Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAclProfileSubscribeTopicExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeTopicExceptionResponse|error - The Subscribe Topic Exception object's attributes after being created, and the request metadata.

getMsgVpnAclProfileSubscribeTopicException

Isolated FunctionRemote Function

function getMsgVpnAclProfileSubscribeTopicException(string msgVpnName, string aclProfileName, string subscribeTopicExceptionSyntax, string subscribeTopicException, map<string|string[]> headers, *GetMsgVpnAclProfileSubscribeTopicExceptionQueries queries) returns MsgVpnAclProfileSubscribeTopicExceptionResponse|error

Get a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

subscribeTopicExceptionSyntax string - The syntax of the topic for the exception to the default action taken.

subscribeTopicException string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAclProfileSubscribeTopicExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnAclProfileSubscribeTopicExceptionResponse|error - The Subscribe Topic Exception object's attributes, and the request metadata.

deleteMsgVpnAclProfileSubscribeTopicException

Isolated FunctionRemote Function

function deleteMsgVpnAclProfileSubscribeTopicException(string msgVpnName, string aclProfileName, string subscribeTopicExceptionSyntax, string subscribeTopicException, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Subscribe Topic Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

aclProfileName string - The name of the ACL Profile.

subscribeTopicExceptionSyntax string - The syntax of the topic for the exception to the default action taken.

subscribeTopicException string - The topic for the exception to the default action taken. May include wildcard characters.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAuthenticationKerberosRealms

Isolated FunctionRemote Function

function getMsgVpnAuthenticationKerberosRealms(string msgVpnName, map<string|string[]> headers, *GetMsgVpnAuthenticationKerberosRealmsQueries queries) returns MsgVpnAuthenticationKerberosRealmsResponse|error

Get a list of Realm objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationKerberosRealmsQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationKerberosRealmsResponse|error - The list of Realm objects' attributes, and the request metadata.

createMsgVpnAuthenticationKerberosRealm

Isolated FunctionRemote Function

function createMsgVpnAuthenticationKerberosRealm(string msgVpnName, MsgVpnAuthenticationKerberosRealm payload, map<string|string[]> headers, *CreateMsgVpnAuthenticationKerberosRealmQueries queries) returns MsgVpnAuthenticationKerberosRealmResponse|error

Create a Realm object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnAuthenticationKerberosRealm - The Realm object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthenticationKerberosRealmQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationKerberosRealmResponse|error - The Realm object's attributes after being created, and the request metadata.

getMsgVpnAuthenticationKerberosRealm

Isolated FunctionRemote Function

function getMsgVpnAuthenticationKerberosRealm(string msgVpnName, string kerberosRealmName, map<string|string[]> headers, *GetMsgVpnAuthenticationKerberosRealmQueries queries) returns MsgVpnAuthenticationKerberosRealmResponse|error

Get a Realm object.

Parameters

msgVpnName string - The name of the Message VPN.

kerberosRealmName string - The Realm Name. Must start with "@", typically all uppercase.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationKerberosRealmQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationKerberosRealmResponse|error - The Realm object's attributes, and the request metadata.

replaceMsgVpnAuthenticationKerberosRealm

Isolated FunctionRemote Function

function replaceMsgVpnAuthenticationKerberosRealm(string msgVpnName, string kerberosRealmName, MsgVpnAuthenticationKerberosRealm payload, map<string|string[]> headers, *ReplaceMsgVpnAuthenticationKerberosRealmQueries queries) returns MsgVpnAuthenticationKerberosRealmResponse|error

Replace a Realm object.

Parameters

msgVpnName string - The name of the Message VPN.

kerberosRealmName string - The Realm Name. Must start with "@", typically all uppercase.

payload MsgVpnAuthenticationKerberosRealm - The Realm object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnAuthenticationKerberosRealmQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationKerberosRealmResponse|error - The Realm object's attributes after being replaced, and the request metadata.

deleteMsgVpnAuthenticationKerberosRealm

Isolated FunctionRemote Function

function deleteMsgVpnAuthenticationKerberosRealm(string msgVpnName, string kerberosRealmName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Realm object.

Parameters

msgVpnName string - The name of the Message VPN.

kerberosRealmName string - The Realm Name. Must start with "@", typically all uppercase.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnAuthenticationKerberosRealm

Isolated FunctionRemote Function

function updateMsgVpnAuthenticationKerberosRealm(string msgVpnName, string kerberosRealmName, MsgVpnAuthenticationKerberosRealm payload, map<string|string[]> headers, *UpdateMsgVpnAuthenticationKerberosRealmQueries queries) returns MsgVpnAuthenticationKerberosRealmResponse|error

Update a Realm object.

Parameters

msgVpnName string - The name of the Message VPN.

kerberosRealmName string - The Realm Name. Must start with "@", typically all uppercase.

payload MsgVpnAuthenticationKerberosRealm - The Realm object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnAuthenticationKerberosRealmQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationKerberosRealmResponse|error - The Realm object's attributes after being updated, and the request metadata.

getMsgVpnAuthenticationOauthProfiles

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfiles(string msgVpnName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfilesQueries queries) returns MsgVpnAuthenticationOauthProfilesResponse|error

Get a list of OAuth Profile objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfilesQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfilesResponse|error - The list of OAuth Profile objects' attributes, and the request metadata.

createMsgVpnAuthenticationOauthProfile

Isolated FunctionRemote Function

function createMsgVpnAuthenticationOauthProfile(string msgVpnName, MsgVpnAuthenticationOauthProfile payload, map<string|string[]> headers, *CreateMsgVpnAuthenticationOauthProfileQueries queries) returns MsgVpnAuthenticationOauthProfileResponse|error

Create an OAuth Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnAuthenticationOauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthenticationOauthProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResponse|error - The OAuth Profile object's attributes after being created, and the request metadata.

getMsgVpnAuthenticationOauthProfile

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfile(string msgVpnName, string oauthProfileName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfileQueries queries) returns MsgVpnAuthenticationOauthProfileResponse|error

Get an OAuth Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResponse|error - The OAuth Profile object's attributes, and the request metadata.

replaceMsgVpnAuthenticationOauthProfile

Isolated FunctionRemote Function

function replaceMsgVpnAuthenticationOauthProfile(string msgVpnName, string oauthProfileName, MsgVpnAuthenticationOauthProfile payload, map<string|string[]> headers, *ReplaceMsgVpnAuthenticationOauthProfileQueries queries) returns MsgVpnAuthenticationOauthProfileResponse|error

Replace an OAuth Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

payload MsgVpnAuthenticationOauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnAuthenticationOauthProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResponse|error - The OAuth Profile object's attributes after being replaced, and the request metadata.

deleteMsgVpnAuthenticationOauthProfile

Isolated FunctionRemote Function

function deleteMsgVpnAuthenticationOauthProfile(string msgVpnName, string oauthProfileName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an OAuth Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnAuthenticationOauthProfile

Isolated FunctionRemote Function

function updateMsgVpnAuthenticationOauthProfile(string msgVpnName, string oauthProfileName, MsgVpnAuthenticationOauthProfile payload, map<string|string[]> headers, *UpdateMsgVpnAuthenticationOauthProfileQueries queries) returns MsgVpnAuthenticationOauthProfileResponse|error

Update an OAuth Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

payload MsgVpnAuthenticationOauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnAuthenticationOauthProfileQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResponse|error - The OAuth Profile object's attributes after being updated, and the request metadata.

getMsgVpnAuthenticationOauthProfileClientRequiredClaims

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfileClientRequiredClaims(string msgVpnName, string oauthProfileName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfileClientRequiredClaimsQueries queries) returns MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse|error

Get a list of Required Claim objects.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfileClientRequiredClaimsQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse|error - The list of Required Claim objects' attributes, and the request metadata.

createMsgVpnAuthenticationOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function createMsgVpnAuthenticationOauthProfileClientRequiredClaim(string msgVpnName, string oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim payload, map<string|string[]> headers, *CreateMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries queries) returns MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse|error

Create a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

payload MsgVpnAuthenticationOauthProfileClientRequiredClaim - The Required Claim object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse|error - The Required Claim object's attributes after being created, and the request metadata.

getMsgVpnAuthenticationOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfileClientRequiredClaim(string msgVpnName, string oauthProfileName, string clientRequiredClaimName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries queries) returns MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse|error

Get a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

clientRequiredClaimName string - The name of the ID token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse|error - The Required Claim object's attributes, and the request metadata.

deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(string msgVpnName, string oauthProfileName, string clientRequiredClaimName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

clientRequiredClaimName string - The name of the ID token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(string msgVpnName, string oauthProfileName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsQueries queries) returns MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse|error

Get a list of Required Claim objects.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse|error - The list of Required Claim objects' attributes, and the request metadata.

createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(string msgVpnName, string oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim payload, map<string|string[]> headers, *CreateMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries queries) returns MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse|error

Create a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

payload MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - The Required Claim object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse|error - The Required Claim object's attributes after being created, and the request metadata.

getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(string msgVpnName, string oauthProfileName, string resourceServerRequiredClaimName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries queries) returns MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse|error

Get a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

resourceServerRequiredClaimName string - The name of the access token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse|error - The Required Claim object's attributes, and the request metadata.

deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(string msgVpnName, string oauthProfileName, string resourceServerRequiredClaimName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Required Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProfileName string - The name of the OAuth profile.

resourceServerRequiredClaimName string - The name of the access token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnAuthenticationOauthProviders

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProviders(string msgVpnName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProvidersQueries queries) returns MsgVpnAuthenticationOauthProvidersResponse|error

Get a list of OAuth Provider objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProvidersQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProvidersResponse|error - The list of OAuth Provider objects' attributes, and the request metadata.

Deprecated

createMsgVpnAuthenticationOauthProvider

DeprecatedIsolated FunctionRemote Function

function createMsgVpnAuthenticationOauthProvider(string msgVpnName, MsgVpnAuthenticationOauthProvider payload, map<string|string[]> headers, *CreateMsgVpnAuthenticationOauthProviderQueries queries) returns MsgVpnAuthenticationOauthProviderResponse|error

Create an OAuth Provider object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnAuthenticationOauthProvider - The OAuth Provider object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthenticationOauthProviderQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProviderResponse|error - The OAuth Provider object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnAuthenticationOauthProvider

DeprecatedIsolated FunctionRemote Function

function getMsgVpnAuthenticationOauthProvider(string msgVpnName, string oauthProviderName, map<string|string[]> headers, *GetMsgVpnAuthenticationOauthProviderQueries queries) returns MsgVpnAuthenticationOauthProviderResponse|error

Get an OAuth Provider object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProviderName string - The name of the OAuth Provider.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthenticationOauthProviderQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProviderResponse|error - The OAuth Provider object's attributes, and the request metadata.

Deprecated

replaceMsgVpnAuthenticationOauthProvider

DeprecatedIsolated FunctionRemote Function

function replaceMsgVpnAuthenticationOauthProvider(string msgVpnName, string oauthProviderName, MsgVpnAuthenticationOauthProvider payload, map<string|string[]> headers, *ReplaceMsgVpnAuthenticationOauthProviderQueries queries) returns MsgVpnAuthenticationOauthProviderResponse|error

Replace an OAuth Provider object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProviderName string - The name of the OAuth Provider.

payload MsgVpnAuthenticationOauthProvider - The OAuth Provider object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnAuthenticationOauthProviderQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProviderResponse|error - The OAuth Provider object's attributes after being replaced, and the request metadata.

Deprecated

deleteMsgVpnAuthenticationOauthProvider

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnAuthenticationOauthProvider(string msgVpnName, string oauthProviderName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an OAuth Provider object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProviderName string - The name of the OAuth Provider.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

updateMsgVpnAuthenticationOauthProvider

DeprecatedIsolated FunctionRemote Function

function updateMsgVpnAuthenticationOauthProvider(string msgVpnName, string oauthProviderName, MsgVpnAuthenticationOauthProvider payload, map<string|string[]> headers, *UpdateMsgVpnAuthenticationOauthProviderQueries queries) returns MsgVpnAuthenticationOauthProviderResponse|error

Update an OAuth Provider object.

Parameters

msgVpnName string - The name of the Message VPN.

oauthProviderName string - The name of the OAuth Provider.

payload MsgVpnAuthenticationOauthProvider - The OAuth Provider object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnAuthenticationOauthProviderQueries - Queries to be sent with the request

Return Type

MsgVpnAuthenticationOauthProviderResponse|error - The OAuth Provider object's attributes after being updated, and the request metadata.

Deprecated

getMsgVpnAuthorizationGroups

Isolated FunctionRemote Function

function getMsgVpnAuthorizationGroups(string msgVpnName, map<string|string[]> headers, *GetMsgVpnAuthorizationGroupsQueries queries) returns MsgVpnAuthorizationGroupsResponse|error

Get a list of Authorization Group objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthorizationGroupsQueries - Queries to be sent with the request

Return Type

MsgVpnAuthorizationGroupsResponse|error - The list of Authorization Group objects' attributes, and the request metadata.

createMsgVpnAuthorizationGroup

Isolated FunctionRemote Function

function createMsgVpnAuthorizationGroup(string msgVpnName, MsgVpnAuthorizationGroup payload, map<string|string[]> headers, *CreateMsgVpnAuthorizationGroupQueries queries) returns MsgVpnAuthorizationGroupResponse|error

Create an Authorization Group object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnAuthorizationGroup - The Authorization Group object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnAuthorizationGroupQueries - Queries to be sent with the request

Return Type

MsgVpnAuthorizationGroupResponse|error - The Authorization Group object's attributes after being created, and the request metadata.

getMsgVpnAuthorizationGroup

Isolated FunctionRemote Function

function getMsgVpnAuthorizationGroup(string msgVpnName, string authorizationGroupName, map<string|string[]> headers, *GetMsgVpnAuthorizationGroupQueries queries) returns MsgVpnAuthorizationGroupResponse|error

Get an Authorization Group object.

Parameters

msgVpnName string - The name of the Message VPN.

authorizationGroupName string - The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with ''. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test#,lab,com'.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnAuthorizationGroupQueries - Queries to be sent with the request

Return Type

MsgVpnAuthorizationGroupResponse|error - The Authorization Group object's attributes, and the request metadata.

replaceMsgVpnAuthorizationGroup

Isolated FunctionRemote Function

function replaceMsgVpnAuthorizationGroup(string msgVpnName, string authorizationGroupName, MsgVpnAuthorizationGroup payload, map<string|string[]> headers, *ReplaceMsgVpnAuthorizationGroupQueries queries) returns MsgVpnAuthorizationGroupResponse|error

Replace an Authorization Group object.

Parameters

msgVpnName string - The name of the Message VPN.

authorizationGroupName string - The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with ''. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test#,lab,com'.

payload MsgVpnAuthorizationGroup - The Authorization Group object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnAuthorizationGroupQueries - Queries to be sent with the request

Return Type

MsgVpnAuthorizationGroupResponse|error - The Authorization Group object's attributes after being replaced, and the request metadata.

deleteMsgVpnAuthorizationGroup

Isolated FunctionRemote Function

function deleteMsgVpnAuthorizationGroup(string msgVpnName, string authorizationGroupName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an Authorization Group object.

Parameters

msgVpnName string - The name of the Message VPN.

authorizationGroupName string - The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with ''. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test#,lab,com'.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnAuthorizationGroup

Isolated FunctionRemote Function

function updateMsgVpnAuthorizationGroup(string msgVpnName, string authorizationGroupName, MsgVpnAuthorizationGroup payload, map<string|string[]> headers, *UpdateMsgVpnAuthorizationGroupQueries queries) returns MsgVpnAuthorizationGroupResponse|error

Update an Authorization Group object.

Parameters

msgVpnName string - The name of the Message VPN.

authorizationGroupName string - The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with ''. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test#,lab,com'.

payload MsgVpnAuthorizationGroup - The Authorization Group object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnAuthorizationGroupQueries - Queries to be sent with the request

Return Type

MsgVpnAuthorizationGroupResponse|error - The Authorization Group object's attributes after being updated, and the request metadata.

getMsgVpnBridges

Isolated FunctionRemote Function

function getMsgVpnBridges(string msgVpnName, map<string|string[]> headers, *GetMsgVpnBridgesQueries queries) returns MsgVpnBridgesResponse|error

Get a list of Bridge objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgesQueries - Queries to be sent with the request

Return Type

MsgVpnBridgesResponse|error - The list of Bridge objects' attributes, and the request metadata.

createMsgVpnBridge

Isolated FunctionRemote Function

function createMsgVpnBridge(string msgVpnName, MsgVpnBridge payload, map<string|string[]> headers, *CreateMsgVpnBridgeQueries queries) returns MsgVpnBridgeResponse|error

Create a Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnBridge - The Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnBridgeQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeResponse|error - The Bridge object's attributes after being created, and the request metadata.

getMsgVpnBridge

Isolated FunctionRemote Function

function getMsgVpnBridge(string msgVpnName, string bridgeName, string bridgeVirtualRouter, map<string|string[]> headers, *GetMsgVpnBridgeQueries queries) returns MsgVpnBridgeResponse|error

Get a Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeResponse|error - The Bridge object's attributes, and the request metadata.

replaceMsgVpnBridge

Isolated FunctionRemote Function

function replaceMsgVpnBridge(string msgVpnName, string bridgeName, string bridgeVirtualRouter, MsgVpnBridge payload, map<string|string[]> headers, *ReplaceMsgVpnBridgeQueries queries) returns MsgVpnBridgeResponse|error

Replace a Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

payload MsgVpnBridge - The Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnBridgeQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeResponse|error - The Bridge object's attributes after being replaced, and the request metadata.

deleteMsgVpnBridge

Isolated FunctionRemote Function

function deleteMsgVpnBridge(string msgVpnName, string bridgeName, string bridgeVirtualRouter, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnBridge

Isolated FunctionRemote Function

function updateMsgVpnBridge(string msgVpnName, string bridgeName, string bridgeVirtualRouter, MsgVpnBridge payload, map<string|string[]> headers, *UpdateMsgVpnBridgeQueries queries) returns MsgVpnBridgeResponse|error

Update a Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

payload MsgVpnBridge - The Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnBridgeQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeResponse|error - The Bridge object's attributes after being updated, and the request metadata.

getMsgVpnBridgeRemoteMsgVpns

Isolated FunctionRemote Function

function getMsgVpnBridgeRemoteMsgVpns(string msgVpnName, string bridgeName, string bridgeVirtualRouter, map<string|string[]> headers, *GetMsgVpnBridgeRemoteMsgVpnsQueries queries) returns MsgVpnBridgeRemoteMsgVpnsResponse|error

Get a list of Remote Message VPN objects.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeRemoteMsgVpnsQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteMsgVpnsResponse|error - The list of Remote Message VPN objects' attributes, and the request metadata.

createMsgVpnBridgeRemoteMsgVpn

Isolated FunctionRemote Function

function createMsgVpnBridgeRemoteMsgVpn(string msgVpnName, string bridgeName, string bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn payload, map<string|string[]> headers, *CreateMsgVpnBridgeRemoteMsgVpnQueries queries) returns MsgVpnBridgeRemoteMsgVpnResponse|error

Create a Remote Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

payload MsgVpnBridgeRemoteMsgVpn - The Remote Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnBridgeRemoteMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteMsgVpnResponse|error - The Remote Message VPN object's attributes after being created, and the request metadata.

getMsgVpnBridgeRemoteMsgVpn

Isolated FunctionRemote Function

function getMsgVpnBridgeRemoteMsgVpn(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteMsgVpnName, string remoteMsgVpnLocation, string remoteMsgVpnInterface, map<string|string[]> headers, *GetMsgVpnBridgeRemoteMsgVpnQueries queries) returns MsgVpnBridgeRemoteMsgVpnResponse|error

Get a Remote Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteMsgVpnName string - The name of the remote Message VPN.

remoteMsgVpnLocation string - The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:").

remoteMsgVpnInterface string - The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeRemoteMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteMsgVpnResponse|error - The Remote Message VPN object's attributes, and the request metadata.

replaceMsgVpnBridgeRemoteMsgVpn

Isolated FunctionRemote Function

function replaceMsgVpnBridgeRemoteMsgVpn(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteMsgVpnName, string remoteMsgVpnLocation, string remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn payload, map<string|string[]> headers, *ReplaceMsgVpnBridgeRemoteMsgVpnQueries queries) returns MsgVpnBridgeRemoteMsgVpnResponse|error

Replace a Remote Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteMsgVpnName string - The name of the remote Message VPN.

remoteMsgVpnLocation string - The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:").

remoteMsgVpnInterface string - The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name.

payload MsgVpnBridgeRemoteMsgVpn - The Remote Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnBridgeRemoteMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteMsgVpnResponse|error - The Remote Message VPN object's attributes after being replaced, and the request metadata.

deleteMsgVpnBridgeRemoteMsgVpn

Isolated FunctionRemote Function

function deleteMsgVpnBridgeRemoteMsgVpn(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteMsgVpnName, string remoteMsgVpnLocation, string remoteMsgVpnInterface, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Remote Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteMsgVpnName string - The name of the remote Message VPN.

remoteMsgVpnLocation string - The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:").

remoteMsgVpnInterface string - The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnBridgeRemoteMsgVpn

Isolated FunctionRemote Function

function updateMsgVpnBridgeRemoteMsgVpn(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteMsgVpnName, string remoteMsgVpnLocation, string remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn payload, map<string|string[]> headers, *UpdateMsgVpnBridgeRemoteMsgVpnQueries queries) returns MsgVpnBridgeRemoteMsgVpnResponse|error

Update a Remote Message VPN object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteMsgVpnName string - The name of the remote Message VPN.

remoteMsgVpnLocation string - The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:").

remoteMsgVpnInterface string - The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name.

payload MsgVpnBridgeRemoteMsgVpn - The Remote Message VPN object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnBridgeRemoteMsgVpnQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteMsgVpnResponse|error - The Remote Message VPN object's attributes after being updated, and the request metadata.

getMsgVpnBridgeRemoteSubscriptions

Isolated FunctionRemote Function

function getMsgVpnBridgeRemoteSubscriptions(string msgVpnName, string bridgeName, string bridgeVirtualRouter, map<string|string[]> headers, *GetMsgVpnBridgeRemoteSubscriptionsQueries queries) returns MsgVpnBridgeRemoteSubscriptionsResponse|error

Get a list of Remote Subscription objects.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeRemoteSubscriptionsQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteSubscriptionsResponse|error - The list of Remote Subscription objects' attributes, and the request metadata.

createMsgVpnBridgeRemoteSubscription

Isolated FunctionRemote Function

function createMsgVpnBridgeRemoteSubscription(string msgVpnName, string bridgeName, string bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription payload, map<string|string[]> headers, *CreateMsgVpnBridgeRemoteSubscriptionQueries queries) returns MsgVpnBridgeRemoteSubscriptionResponse|error

Create a Remote Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

payload MsgVpnBridgeRemoteSubscription - The Remote Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnBridgeRemoteSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteSubscriptionResponse|error - The Remote Subscription object's attributes after being created, and the request metadata.

getMsgVpnBridgeRemoteSubscription

Isolated FunctionRemote Function

function getMsgVpnBridgeRemoteSubscription(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteSubscriptionTopic, map<string|string[]> headers, *GetMsgVpnBridgeRemoteSubscriptionQueries queries) returns MsgVpnBridgeRemoteSubscriptionResponse|error

Get a Remote Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteSubscriptionTopic string - The topic of the Bridge remote subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeRemoteSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeRemoteSubscriptionResponse|error - The Remote Subscription object's attributes, and the request metadata.

deleteMsgVpnBridgeRemoteSubscription

Isolated FunctionRemote Function

function deleteMsgVpnBridgeRemoteSubscription(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string remoteSubscriptionTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Remote Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

remoteSubscriptionTopic string - The topic of the Bridge remote subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnBridgeTlsTrustedCommonNames

DeprecatedIsolated FunctionRemote Function

function getMsgVpnBridgeTlsTrustedCommonNames(string msgVpnName, string bridgeName, string bridgeVirtualRouter, map<string|string[]> headers, *GetMsgVpnBridgeTlsTrustedCommonNamesQueries queries) returns MsgVpnBridgeTlsTrustedCommonNamesResponse|error

Get a list of Trusted Common Name objects.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeTlsTrustedCommonNamesQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeTlsTrustedCommonNamesResponse|error - The list of Trusted Common Name objects' attributes, and the request metadata.

Deprecated

createMsgVpnBridgeTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function createMsgVpnBridgeTlsTrustedCommonName(string msgVpnName, string bridgeName, string bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName payload, map<string|string[]> headers, *CreateMsgVpnBridgeTlsTrustedCommonNameQueries queries) returns MsgVpnBridgeTlsTrustedCommonNameResponse|error

Create a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

payload MsgVpnBridgeTlsTrustedCommonName - The Trusted Common Name object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnBridgeTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnBridgeTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function getMsgVpnBridgeTlsTrustedCommonName(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string tlsTrustedCommonName, map<string|string[]> headers, *GetMsgVpnBridgeTlsTrustedCommonNameQueries queries) returns MsgVpnBridgeTlsTrustedCommonNameResponse|error

Get a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnBridgeTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

MsgVpnBridgeTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes, and the request metadata.

Deprecated

deleteMsgVpnBridgeTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnBridgeTlsTrustedCommonName(string msgVpnName, string bridgeName, string bridgeVirtualRouter, string tlsTrustedCommonName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

bridgeName string - The name of the Bridge.

bridgeVirtualRouter string - The virtual router of the Bridge.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getMsgVpnCertMatchingRules

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRules(string msgVpnName, map<string|string[]> headers, *GetMsgVpnCertMatchingRulesQueries queries) returns MsgVpnCertMatchingRulesResponse|error

Get a list of Certificate Matching Rule objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRulesQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRulesResponse|error - The list of Certificate Matching Rule objects' attributes, and the request metadata.

createMsgVpnCertMatchingRule

Isolated FunctionRemote Function

function createMsgVpnCertMatchingRule(string msgVpnName, MsgVpnCertMatchingRule payload, map<string|string[]> headers, *CreateMsgVpnCertMatchingRuleQueries queries) returns MsgVpnCertMatchingRuleResponse|error

Create a Certificate Matching Rule object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnCertMatchingRuleQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being created, and the request metadata.

getMsgVpnCertMatchingRule

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRule(string msgVpnName, string ruleName, map<string|string[]> headers, *GetMsgVpnCertMatchingRuleQueries queries) returns MsgVpnCertMatchingRuleResponse|error

Get a Certificate Matching Rule object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRuleQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes, and the request metadata.

replaceMsgVpnCertMatchingRule

Isolated FunctionRemote Function

function replaceMsgVpnCertMatchingRule(string msgVpnName, string ruleName, MsgVpnCertMatchingRule payload, map<string|string[]> headers, *ReplaceMsgVpnCertMatchingRuleQueries queries) returns MsgVpnCertMatchingRuleResponse|error

Replace a Certificate Matching Rule object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

payload MsgVpnCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnCertMatchingRuleQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being replaced, and the request metadata.

deleteMsgVpnCertMatchingRule

Isolated FunctionRemote Function

function deleteMsgVpnCertMatchingRule(string msgVpnName, string ruleName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnCertMatchingRule

Isolated FunctionRemote Function

function updateMsgVpnCertMatchingRule(string msgVpnName, string ruleName, MsgVpnCertMatchingRule payload, map<string|string[]> headers, *UpdateMsgVpnCertMatchingRuleQueries queries) returns MsgVpnCertMatchingRuleResponse|error

Update a Certificate Matching Rule object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

payload MsgVpnCertMatchingRule - The Certificate Matching Rule object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnCertMatchingRuleQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleResponse|error - The Certificate Matching Rule object's attributes after being updated, and the request metadata.

getMsgVpnCertMatchingRuleAttributeFilters

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRuleAttributeFilters(string msgVpnName, string ruleName, map<string|string[]> headers, *GetMsgVpnCertMatchingRuleAttributeFiltersQueries queries) returns MsgVpnCertMatchingRuleAttributeFiltersResponse|error

Get a list of Certificate Matching Rule Attribute Filter objects.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRuleAttributeFiltersQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleAttributeFiltersResponse|error - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.

createMsgVpnCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function createMsgVpnCertMatchingRuleAttributeFilter(string msgVpnName, string ruleName, MsgVpnCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *CreateMsgVpnCertMatchingRuleAttributeFilterQueries queries) returns MsgVpnCertMatchingRuleAttributeFilterResponse|error

Create a Certificate Matching Rule Attribute Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

payload MsgVpnCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.

getMsgVpnCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRuleAttributeFilter(string msgVpnName, string ruleName, string filterName, map<string|string[]> headers, *GetMsgVpnCertMatchingRuleAttributeFilterQueries queries) returns MsgVpnCertMatchingRuleAttributeFilterResponse|error

Get a Certificate Matching Rule Attribute Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

filterName string - The name of the filter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.

replaceMsgVpnCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function replaceMsgVpnCertMatchingRuleAttributeFilter(string msgVpnName, string ruleName, string filterName, MsgVpnCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *ReplaceMsgVpnCertMatchingRuleAttributeFilterQueries queries) returns MsgVpnCertMatchingRuleAttributeFilterResponse|error

Replace a Certificate Matching Rule Attribute Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

filterName string - The name of the filter.

payload MsgVpnCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.

deleteMsgVpnCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function deleteMsgVpnCertMatchingRuleAttributeFilter(string msgVpnName, string ruleName, string filterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule Attribute Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

filterName string - The name of the filter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnCertMatchingRuleAttributeFilter

Isolated FunctionRemote Function

function updateMsgVpnCertMatchingRuleAttributeFilter(string msgVpnName, string ruleName, string filterName, MsgVpnCertMatchingRuleAttributeFilter payload, map<string|string[]> headers, *UpdateMsgVpnCertMatchingRuleAttributeFilterQueries queries) returns MsgVpnCertMatchingRuleAttributeFilterResponse|error

Update a Certificate Matching Rule Attribute Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

filterName string - The name of the filter.

payload MsgVpnCertMatchingRuleAttributeFilter - The Certificate Matching Rule Attribute Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnCertMatchingRuleAttributeFilterQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleAttributeFilterResponse|error - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.

getMsgVpnCertMatchingRuleConditions

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRuleConditions(string msgVpnName, string ruleName, map<string|string[]> headers, *GetMsgVpnCertMatchingRuleConditionsQueries queries) returns MsgVpnCertMatchingRuleConditionsResponse|error

Get a list of Certificate Matching Rule Condition objects.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRuleConditionsQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleConditionsResponse|error - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.

createMsgVpnCertMatchingRuleCondition

Isolated FunctionRemote Function

function createMsgVpnCertMatchingRuleCondition(string msgVpnName, string ruleName, MsgVpnCertMatchingRuleCondition payload, map<string|string[]> headers, *CreateMsgVpnCertMatchingRuleConditionQueries queries) returns MsgVpnCertMatchingRuleConditionResponse|error

Create a Certificate Matching Rule Condition object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

payload MsgVpnCertMatchingRuleCondition - The Certificate Matching Rule Condition object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnCertMatchingRuleConditionQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleConditionResponse|error - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.

getMsgVpnCertMatchingRuleCondition

Isolated FunctionRemote Function

function getMsgVpnCertMatchingRuleCondition(string msgVpnName, string ruleName, string 'source, map<string|string[]> headers, *GetMsgVpnCertMatchingRuleConditionQueries queries) returns MsgVpnCertMatchingRuleConditionResponse|error

Get a Certificate Matching Rule Condition object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

'source string - Certificate field to be compared with the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnCertMatchingRuleConditionQueries - Queries to be sent with the request

Return Type

MsgVpnCertMatchingRuleConditionResponse|error - The Certificate Matching Rule Condition object's attributes, and the request metadata.

deleteMsgVpnCertMatchingRuleCondition

Isolated FunctionRemote Function

function deleteMsgVpnCertMatchingRuleCondition(string msgVpnName, string ruleName, string 'source, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Certificate Matching Rule Condition object.

Parameters

msgVpnName string - The name of the Message VPN.

ruleName string - The name of the rule.

'source string - Certificate field to be compared with the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnClientProfiles

Isolated FunctionRemote Function

function getMsgVpnClientProfiles(string msgVpnName, map<string|string[]> headers, *GetMsgVpnClientProfilesQueries queries) returns MsgVpnClientProfilesResponse|error

Get a list of Client Profile objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientProfilesQueries - Queries to be sent with the request

Return Type

MsgVpnClientProfilesResponse|error - The list of Client Profile objects' attributes, and the request metadata.

createMsgVpnClientProfile

Isolated FunctionRemote Function

function createMsgVpnClientProfile(string msgVpnName, MsgVpnClientProfile payload, map<string|string[]> headers, *CreateMsgVpnClientProfileQueries queries) returns MsgVpnClientProfileResponse|error

Create a Client Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnClientProfile - The Client Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnClientProfileQueries - Queries to be sent with the request

Return Type

MsgVpnClientProfileResponse|error - The Client Profile object's attributes after being created, and the request metadata.

getMsgVpnClientProfile

Isolated FunctionRemote Function

function getMsgVpnClientProfile(string msgVpnName, string clientProfileName, map<string|string[]> headers, *GetMsgVpnClientProfileQueries queries) returns MsgVpnClientProfileResponse|error

Get a Client Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

clientProfileName string - The name of the Client Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientProfileQueries - Queries to be sent with the request

Return Type

MsgVpnClientProfileResponse|error - The Client Profile object's attributes, and the request metadata.

replaceMsgVpnClientProfile

Isolated FunctionRemote Function

function replaceMsgVpnClientProfile(string msgVpnName, string clientProfileName, MsgVpnClientProfile payload, map<string|string[]> headers, *ReplaceMsgVpnClientProfileQueries queries) returns MsgVpnClientProfileResponse|error

Replace a Client Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

clientProfileName string - The name of the Client Profile.

payload MsgVpnClientProfile - The Client Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnClientProfileQueries - Queries to be sent with the request

Return Type

MsgVpnClientProfileResponse|error - The Client Profile object's attributes after being replaced, and the request metadata.

deleteMsgVpnClientProfile

Isolated FunctionRemote Function

function deleteMsgVpnClientProfile(string msgVpnName, string clientProfileName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Client Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

clientProfileName string - The name of the Client Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnClientProfile

Isolated FunctionRemote Function

function updateMsgVpnClientProfile(string msgVpnName, string clientProfileName, MsgVpnClientProfile payload, map<string|string[]> headers, *UpdateMsgVpnClientProfileQueries queries) returns MsgVpnClientProfileResponse|error

Update a Client Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

clientProfileName string - The name of the Client Profile.

payload MsgVpnClientProfile - The Client Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnClientProfileQueries - Queries to be sent with the request

Return Type

MsgVpnClientProfileResponse|error - The Client Profile object's attributes after being updated, and the request metadata.

getMsgVpnClientUsernames

Isolated FunctionRemote Function

function getMsgVpnClientUsernames(string msgVpnName, map<string|string[]> headers, *GetMsgVpnClientUsernamesQueries queries) returns MsgVpnClientUsernamesResponse|error

Get a list of Client Username objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientUsernamesQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernamesResponse|error - The list of Client Username objects' attributes, and the request metadata.

createMsgVpnClientUsername

Isolated FunctionRemote Function

function createMsgVpnClientUsername(string msgVpnName, MsgVpnClientUsername payload, map<string|string[]> headers, *CreateMsgVpnClientUsernameQueries queries) returns MsgVpnClientUsernameResponse|error

Create a Client Username object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnClientUsername - The Client Username object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnClientUsernameQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameResponse|error - The Client Username object's attributes after being created, and the request metadata.

getMsgVpnClientUsername

Isolated FunctionRemote Function

function getMsgVpnClientUsername(string msgVpnName, string clientUsername, map<string|string[]> headers, *GetMsgVpnClientUsernameQueries queries) returns MsgVpnClientUsernameResponse|error

Get a Client Username object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientUsernameQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameResponse|error - The Client Username object's attributes, and the request metadata.

replaceMsgVpnClientUsername

Isolated FunctionRemote Function

function replaceMsgVpnClientUsername(string msgVpnName, string clientUsername, MsgVpnClientUsername payload, map<string|string[]> headers, *ReplaceMsgVpnClientUsernameQueries queries) returns MsgVpnClientUsernameResponse|error

Replace a Client Username object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

payload MsgVpnClientUsername - The Client Username object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnClientUsernameQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameResponse|error - The Client Username object's attributes after being replaced, and the request metadata.

deleteMsgVpnClientUsername

Isolated FunctionRemote Function

function deleteMsgVpnClientUsername(string msgVpnName, string clientUsername, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Client Username object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnClientUsername

Isolated FunctionRemote Function

function updateMsgVpnClientUsername(string msgVpnName, string clientUsername, MsgVpnClientUsername payload, map<string|string[]> headers, *UpdateMsgVpnClientUsernameQueries queries) returns MsgVpnClientUsernameResponse|error

Update a Client Username object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

payload MsgVpnClientUsername - The Client Username object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnClientUsernameQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameResponse|error - The Client Username object's attributes after being updated, and the request metadata.

getMsgVpnClientUsernameAttributes

Isolated FunctionRemote Function

function getMsgVpnClientUsernameAttributes(string msgVpnName, string clientUsername, map<string|string[]> headers, *GetMsgVpnClientUsernameAttributesQueries queries) returns MsgVpnClientUsernameAttributesResponse|error

Get a list of Client Username Attribute objects.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientUsernameAttributesQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameAttributesResponse|error - The list of Client Username Attribute objects' attributes, and the request metadata.

createMsgVpnClientUsernameAttribute

Isolated FunctionRemote Function

function createMsgVpnClientUsernameAttribute(string msgVpnName, string clientUsername, MsgVpnClientUsernameAttribute payload, map<string|string[]> headers, *CreateMsgVpnClientUsernameAttributeQueries queries) returns MsgVpnClientUsernameAttributeResponse|error

Create a Client Username Attribute object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

payload MsgVpnClientUsernameAttribute - The Client Username Attribute object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnClientUsernameAttributeQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameAttributeResponse|error - The Client Username Attribute object's attributes after being created, and the request metadata.

getMsgVpnClientUsernameAttribute

Isolated FunctionRemote Function

function getMsgVpnClientUsernameAttribute(string msgVpnName, string clientUsername, string attributeName, string attributeValue, map<string|string[]> headers, *GetMsgVpnClientUsernameAttributeQueries queries) returns MsgVpnClientUsernameAttributeResponse|error

Get a Client Username Attribute object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

attributeName string - The name of the Attribute.

attributeValue string - The value of the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnClientUsernameAttributeQueries - Queries to be sent with the request

Return Type

MsgVpnClientUsernameAttributeResponse|error - The Client Username Attribute object's attributes, and the request metadata.

deleteMsgVpnClientUsernameAttribute

Isolated FunctionRemote Function

function deleteMsgVpnClientUsernameAttribute(string msgVpnName, string clientUsername, string attributeName, string attributeValue, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Client Username Attribute object.

Parameters

msgVpnName string - The name of the Message VPN.

clientUsername string - The name of the Client Username.

attributeName string - The name of the Attribute.

attributeValue string - The value of the Attribute.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnDistributedCaches

Isolated FunctionRemote Function

function getMsgVpnDistributedCaches(string msgVpnName, map<string|string[]> headers, *GetMsgVpnDistributedCachesQueries queries) returns MsgVpnDistributedCachesResponse|error

Get a list of Distributed Cache objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCachesQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCachesResponse|error - The list of Distributed Cache objects' attributes, and the request metadata.

createMsgVpnDistributedCache

Isolated FunctionRemote Function

function createMsgVpnDistributedCache(string msgVpnName, MsgVpnDistributedCache payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheQueries queries) returns MsgVpnDistributedCacheResponse|error

Create a Distributed Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnDistributedCache - The Distributed Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheResponse|error - The Distributed Cache object's attributes after being created, and the request metadata.

getMsgVpnDistributedCache

Isolated FunctionRemote Function

function getMsgVpnDistributedCache(string msgVpnName, string cacheName, map<string|string[]> headers, *GetMsgVpnDistributedCacheQueries queries) returns MsgVpnDistributedCacheResponse|error

Get a Distributed Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheResponse|error - The Distributed Cache object's attributes, and the request metadata.

replaceMsgVpnDistributedCache

Isolated FunctionRemote Function

function replaceMsgVpnDistributedCache(string msgVpnName, string cacheName, MsgVpnDistributedCache payload, map<string|string[]> headers, *ReplaceMsgVpnDistributedCacheQueries queries) returns MsgVpnDistributedCacheResponse|error

Replace a Distributed Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

payload MsgVpnDistributedCache - The Distributed Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnDistributedCacheQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheResponse|error - The Distributed Cache object's attributes after being replaced, and the request metadata.

deleteMsgVpnDistributedCache

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCache(string msgVpnName, string cacheName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Distributed Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnDistributedCache

Isolated FunctionRemote Function

function updateMsgVpnDistributedCache(string msgVpnName, string cacheName, MsgVpnDistributedCache payload, map<string|string[]> headers, *UpdateMsgVpnDistributedCacheQueries queries) returns MsgVpnDistributedCacheResponse|error

Update a Distributed Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

payload MsgVpnDistributedCache - The Distributed Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnDistributedCacheQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheResponse|error - The Distributed Cache object's attributes after being updated, and the request metadata.

getMsgVpnDistributedCacheClusters

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusters(string msgVpnName, string cacheName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClustersQueries queries) returns MsgVpnDistributedCacheClustersResponse|error

Get a list of Cache Cluster objects.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClustersQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClustersResponse|error - The list of Cache Cluster objects' attributes, and the request metadata.

createMsgVpnDistributedCacheCluster

Isolated FunctionRemote Function

function createMsgVpnDistributedCacheCluster(string msgVpnName, string cacheName, MsgVpnDistributedCacheCluster payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheClusterQueries queries) returns MsgVpnDistributedCacheClusterResponse|error

Create a Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

payload MsgVpnDistributedCacheCluster - The Cache Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterResponse|error - The Cache Cluster object's attributes after being created, and the request metadata.

getMsgVpnDistributedCacheCluster

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheCluster(string msgVpnName, string cacheName, string clusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterQueries queries) returns MsgVpnDistributedCacheClusterResponse|error

Get a Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterResponse|error - The Cache Cluster object's attributes, and the request metadata.

replaceMsgVpnDistributedCacheCluster

Isolated FunctionRemote Function

function replaceMsgVpnDistributedCacheCluster(string msgVpnName, string cacheName, string clusterName, MsgVpnDistributedCacheCluster payload, map<string|string[]> headers, *ReplaceMsgVpnDistributedCacheClusterQueries queries) returns MsgVpnDistributedCacheClusterResponse|error

Replace a Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

payload MsgVpnDistributedCacheCluster - The Cache Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnDistributedCacheClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterResponse|error - The Cache Cluster object's attributes after being replaced, and the request metadata.

deleteMsgVpnDistributedCacheCluster

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCacheCluster(string msgVpnName, string cacheName, string clusterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnDistributedCacheCluster

Isolated FunctionRemote Function

function updateMsgVpnDistributedCacheCluster(string msgVpnName, string cacheName, string clusterName, MsgVpnDistributedCacheCluster payload, map<string|string[]> headers, *UpdateMsgVpnDistributedCacheClusterQueries queries) returns MsgVpnDistributedCacheClusterResponse|error

Update a Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

payload MsgVpnDistributedCacheCluster - The Cache Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnDistributedCacheClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterResponse|error - The Cache Cluster object's attributes after being updated, and the request metadata.

getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(string msgVpnName, string cacheName, string clusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClustersQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse|error

Get a list of Home Cache Cluster objects.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClustersQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse|error - The list of Home Cache Cluster objects' attributes, and the request metadata.

createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Isolated FunctionRemote Function

function createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(string msgVpnName, string cacheName, string clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse|error

Create a Home Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

payload MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - The Home Cache Cluster object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse|error - The Home Cache Cluster object's attributes after being created, and the request metadata.

getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(string msgVpnName, string cacheName, string clusterName, string homeClusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse|error

Get a Home Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse|error - The Home Cache Cluster object's attributes, and the request metadata.

deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(string msgVpnName, string cacheName, string clusterName, string homeClusterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Home Cache Cluster object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(string msgVpnName, string cacheName, string clusterName, string homeClusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse|error

Get a list of Topic Prefix objects.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse|error - The list of Topic Prefix objects' attributes, and the request metadata.

createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Isolated FunctionRemote Function

function createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(string msgVpnName, string cacheName, string clusterName, string homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse|error

Create a Topic Prefix object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

payload MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - The Topic Prefix object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse|error - The Topic Prefix object's attributes after being created, and the request metadata.

getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(string msgVpnName, string cacheName, string clusterName, string homeClusterName, string topicPrefix, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries queries) returns MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse|error

Get a Topic Prefix object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

topicPrefix string - A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse|error - The Topic Prefix object's attributes, and the request metadata.

deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(string msgVpnName, string cacheName, string clusterName, string homeClusterName, string topicPrefix, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic Prefix object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

homeClusterName string - The name of the remote Home Cache Cluster.

topicPrefix string - A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnDistributedCacheClusterInstances

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterInstances(string msgVpnName, string cacheName, string clusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterInstancesQueries queries) returns MsgVpnDistributedCacheClusterInstancesResponse|error

Get a list of Cache Instance objects.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterInstancesQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterInstancesResponse|error - The list of Cache Instance objects' attributes, and the request metadata.

createMsgVpnDistributedCacheClusterInstance

Isolated FunctionRemote Function

function createMsgVpnDistributedCacheClusterInstance(string msgVpnName, string cacheName, string clusterName, MsgVpnDistributedCacheClusterInstance payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheClusterInstanceQueries queries) returns MsgVpnDistributedCacheClusterInstanceResponse|error

Create a Cache Instance object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

payload MsgVpnDistributedCacheClusterInstance - The Cache Instance object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheClusterInstanceQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterInstanceResponse|error - The Cache Instance object's attributes after being created, and the request metadata.

getMsgVpnDistributedCacheClusterInstance

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterInstance(string msgVpnName, string cacheName, string clusterName, string instanceName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterInstanceQueries queries) returns MsgVpnDistributedCacheClusterInstanceResponse|error

Get a Cache Instance object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

instanceName string - The name of the Cache Instance.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterInstanceQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterInstanceResponse|error - The Cache Instance object's attributes, and the request metadata.

replaceMsgVpnDistributedCacheClusterInstance

Isolated FunctionRemote Function

function replaceMsgVpnDistributedCacheClusterInstance(string msgVpnName, string cacheName, string clusterName, string instanceName, MsgVpnDistributedCacheClusterInstance payload, map<string|string[]> headers, *ReplaceMsgVpnDistributedCacheClusterInstanceQueries queries) returns MsgVpnDistributedCacheClusterInstanceResponse|error

Replace a Cache Instance object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

instanceName string - The name of the Cache Instance.

payload MsgVpnDistributedCacheClusterInstance - The Cache Instance object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnDistributedCacheClusterInstanceQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterInstanceResponse|error - The Cache Instance object's attributes after being replaced, and the request metadata.

deleteMsgVpnDistributedCacheClusterInstance

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCacheClusterInstance(string msgVpnName, string cacheName, string clusterName, string instanceName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Cache Instance object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

instanceName string - The name of the Cache Instance.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnDistributedCacheClusterInstance

Isolated FunctionRemote Function

function updateMsgVpnDistributedCacheClusterInstance(string msgVpnName, string cacheName, string clusterName, string instanceName, MsgVpnDistributedCacheClusterInstance payload, map<string|string[]> headers, *UpdateMsgVpnDistributedCacheClusterInstanceQueries queries) returns MsgVpnDistributedCacheClusterInstanceResponse|error

Update a Cache Instance object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

instanceName string - The name of the Cache Instance.

payload MsgVpnDistributedCacheClusterInstance - The Cache Instance object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnDistributedCacheClusterInstanceQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterInstanceResponse|error - The Cache Instance object's attributes after being updated, and the request metadata.

getMsgVpnDistributedCacheClusterTopics

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterTopics(string msgVpnName, string cacheName, string clusterName, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterTopicsQueries queries) returns MsgVpnDistributedCacheClusterTopicsResponse|error

Get a list of Topic objects.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterTopicsQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterTopicsResponse|error - The list of Topic objects' attributes, and the request metadata.

createMsgVpnDistributedCacheClusterTopic

Isolated FunctionRemote Function

function createMsgVpnDistributedCacheClusterTopic(string msgVpnName, string cacheName, string clusterName, MsgVpnDistributedCacheClusterTopic payload, map<string|string[]> headers, *CreateMsgVpnDistributedCacheClusterTopicQueries queries) returns MsgVpnDistributedCacheClusterTopicResponse|error

Create a Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

payload MsgVpnDistributedCacheClusterTopic - The Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDistributedCacheClusterTopicQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterTopicResponse|error - The Topic object's attributes after being created, and the request metadata.

getMsgVpnDistributedCacheClusterTopic

Isolated FunctionRemote Function

function getMsgVpnDistributedCacheClusterTopic(string msgVpnName, string cacheName, string clusterName, string topic, map<string|string[]> headers, *GetMsgVpnDistributedCacheClusterTopicQueries queries) returns MsgVpnDistributedCacheClusterTopicResponse|error

Get a Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

topic string - The value of the Topic in the form a/b/c.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDistributedCacheClusterTopicQueries - Queries to be sent with the request

Return Type

MsgVpnDistributedCacheClusterTopicResponse|error - The Topic object's attributes, and the request metadata.

deleteMsgVpnDistributedCacheClusterTopic

Isolated FunctionRemote Function

function deleteMsgVpnDistributedCacheClusterTopic(string msgVpnName, string cacheName, string clusterName, string topic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the Distributed Cache.

clusterName string - The name of the Cache Cluster.

topic string - The value of the Topic in the form a/b/c.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnDmrBridges

Isolated FunctionRemote Function

function getMsgVpnDmrBridges(string msgVpnName, map<string|string[]> headers, *GetMsgVpnDmrBridgesQueries queries) returns MsgVpnDmrBridgesResponse|error

Get a list of DMR Bridge objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDmrBridgesQueries - Queries to be sent with the request

Return Type

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

createMsgVpnDmrBridge

Isolated FunctionRemote Function

function createMsgVpnDmrBridge(string msgVpnName, MsgVpnDmrBridge payload, map<string|string[]> headers, *CreateMsgVpnDmrBridgeQueries queries) returns MsgVpnDmrBridgeResponse|error

Create a DMR Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnDmrBridge - The DMR Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnDmrBridgeQueries - Queries to be sent with the request

Return Type

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

getMsgVpnDmrBridge

Isolated FunctionRemote Function

function getMsgVpnDmrBridge(string msgVpnName, string remoteNodeName, map<string|string[]> headers, *GetMsgVpnDmrBridgeQueries queries) returns MsgVpnDmrBridgeResponse|error

Get a DMR Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

remoteNodeName string - The name of the node at the remote end of the DMR Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnDmrBridgeQueries - Queries to be sent with the request

Return Type

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

replaceMsgVpnDmrBridge

Isolated FunctionRemote Function

function replaceMsgVpnDmrBridge(string msgVpnName, string remoteNodeName, MsgVpnDmrBridge payload, map<string|string[]> headers, *ReplaceMsgVpnDmrBridgeQueries queries) returns MsgVpnDmrBridgeResponse|error

Replace a DMR Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

remoteNodeName string - The name of the node at the remote end of the DMR Bridge.

payload MsgVpnDmrBridge - The DMR Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnDmrBridgeQueries - Queries to be sent with the request

Return Type

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

deleteMsgVpnDmrBridge

Isolated FunctionRemote Function

function deleteMsgVpnDmrBridge(string msgVpnName, string remoteNodeName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a DMR Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

remoteNodeName string - The name of the node at the remote end of the DMR Bridge.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnDmrBridge

Isolated FunctionRemote Function

function updateMsgVpnDmrBridge(string msgVpnName, string remoteNodeName, MsgVpnDmrBridge payload, map<string|string[]> headers, *UpdateMsgVpnDmrBridgeQueries queries) returns MsgVpnDmrBridgeResponse|error

Update a DMR Bridge object.

Parameters

msgVpnName string - The name of the Message VPN.

remoteNodeName string - The name of the node at the remote end of the DMR Bridge.

payload MsgVpnDmrBridge - The DMR Bridge object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnDmrBridgeQueries - Queries to be sent with the request

Return Type

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

getMsgVpnJndiConnectionFactories

Isolated FunctionRemote Function

function getMsgVpnJndiConnectionFactories(string msgVpnName, map<string|string[]> headers, *GetMsgVpnJndiConnectionFactoriesQueries queries) returns MsgVpnJndiConnectionFactoriesResponse|error

Get a list of JNDI Connection Factory objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiConnectionFactoriesQueries - Queries to be sent with the request

Return Type

MsgVpnJndiConnectionFactoriesResponse|error - The list of JNDI Connection Factory objects' attributes, and the request metadata.

createMsgVpnJndiConnectionFactory

Isolated FunctionRemote Function

function createMsgVpnJndiConnectionFactory(string msgVpnName, MsgVpnJndiConnectionFactory payload, map<string|string[]> headers, *CreateMsgVpnJndiConnectionFactoryQueries queries) returns MsgVpnJndiConnectionFactoryResponse|error

Create a JNDI Connection Factory object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnJndiConnectionFactory - The JNDI Connection Factory object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnJndiConnectionFactoryQueries - Queries to be sent with the request

Return Type

MsgVpnJndiConnectionFactoryResponse|error - The JNDI Connection Factory object's attributes after being created, and the request metadata.

getMsgVpnJndiConnectionFactory

Isolated FunctionRemote Function

function getMsgVpnJndiConnectionFactory(string msgVpnName, string connectionFactoryName, map<string|string[]> headers, *GetMsgVpnJndiConnectionFactoryQueries queries) returns MsgVpnJndiConnectionFactoryResponse|error

Get a JNDI Connection Factory object.

Parameters

msgVpnName string - The name of the Message VPN.

connectionFactoryName string - The name of the JMS Connection Factory.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiConnectionFactoryQueries - Queries to be sent with the request

Return Type

MsgVpnJndiConnectionFactoryResponse|error - The JNDI Connection Factory object's attributes, and the request metadata.

replaceMsgVpnJndiConnectionFactory

Isolated FunctionRemote Function

function replaceMsgVpnJndiConnectionFactory(string msgVpnName, string connectionFactoryName, MsgVpnJndiConnectionFactory payload, map<string|string[]> headers, *ReplaceMsgVpnJndiConnectionFactoryQueries queries) returns MsgVpnJndiConnectionFactoryResponse|error

Replace a JNDI Connection Factory object.

Parameters

msgVpnName string - The name of the Message VPN.

connectionFactoryName string - The name of the JMS Connection Factory.

payload MsgVpnJndiConnectionFactory - The JNDI Connection Factory object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnJndiConnectionFactoryQueries - Queries to be sent with the request

Return Type

MsgVpnJndiConnectionFactoryResponse|error - The JNDI Connection Factory object's attributes after being replaced, and the request metadata.

deleteMsgVpnJndiConnectionFactory

Isolated FunctionRemote Function

function deleteMsgVpnJndiConnectionFactory(string msgVpnName, string connectionFactoryName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a JNDI Connection Factory object.

Parameters

msgVpnName string - The name of the Message VPN.

connectionFactoryName string - The name of the JMS Connection Factory.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnJndiConnectionFactory

Isolated FunctionRemote Function

function updateMsgVpnJndiConnectionFactory(string msgVpnName, string connectionFactoryName, MsgVpnJndiConnectionFactory payload, map<string|string[]> headers, *UpdateMsgVpnJndiConnectionFactoryQueries queries) returns MsgVpnJndiConnectionFactoryResponse|error

Update a JNDI Connection Factory object.

Parameters

msgVpnName string - The name of the Message VPN.

connectionFactoryName string - The name of the JMS Connection Factory.

payload MsgVpnJndiConnectionFactory - The JNDI Connection Factory object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnJndiConnectionFactoryQueries - Queries to be sent with the request

Return Type

MsgVpnJndiConnectionFactoryResponse|error - The JNDI Connection Factory object's attributes after being updated, and the request metadata.

getMsgVpnJndiQueues

Isolated FunctionRemote Function

function getMsgVpnJndiQueues(string msgVpnName, map<string|string[]> headers, *GetMsgVpnJndiQueuesQueries queries) returns MsgVpnJndiQueuesResponse|error

Get a list of JNDI Queue objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiQueuesQueries - Queries to be sent with the request

Return Type

MsgVpnJndiQueuesResponse|error - The list of JNDI Queue objects' attributes, and the request metadata.

createMsgVpnJndiQueue

Isolated FunctionRemote Function

function createMsgVpnJndiQueue(string msgVpnName, MsgVpnJndiQueue payload, map<string|string[]> headers, *CreateMsgVpnJndiQueueQueries queries) returns MsgVpnJndiQueueResponse|error

Create a JNDI Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnJndiQueue - The JNDI Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnJndiQueueQueries - Queries to be sent with the request

Return Type

MsgVpnJndiQueueResponse|error - The JNDI Queue object's attributes after being created, and the request metadata.

getMsgVpnJndiQueue

Isolated FunctionRemote Function

function getMsgVpnJndiQueue(string msgVpnName, string queueName, map<string|string[]> headers, *GetMsgVpnJndiQueueQueries queries) returns MsgVpnJndiQueueResponse|error

Get a JNDI Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The JNDI name of the JMS Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiQueueQueries - Queries to be sent with the request

Return Type

MsgVpnJndiQueueResponse|error - The JNDI Queue object's attributes, and the request metadata.

replaceMsgVpnJndiQueue

Isolated FunctionRemote Function

function replaceMsgVpnJndiQueue(string msgVpnName, string queueName, MsgVpnJndiQueue payload, map<string|string[]> headers, *ReplaceMsgVpnJndiQueueQueries queries) returns MsgVpnJndiQueueResponse|error

Replace a JNDI Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The JNDI name of the JMS Queue.

payload MsgVpnJndiQueue - The JNDI Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnJndiQueueQueries - Queries to be sent with the request

Return Type

MsgVpnJndiQueueResponse|error - The JNDI Queue object's attributes after being replaced, and the request metadata.

deleteMsgVpnJndiQueue

Isolated FunctionRemote Function

function deleteMsgVpnJndiQueue(string msgVpnName, string queueName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a JNDI Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The JNDI name of the JMS Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnJndiQueue

Isolated FunctionRemote Function

function updateMsgVpnJndiQueue(string msgVpnName, string queueName, MsgVpnJndiQueue payload, map<string|string[]> headers, *UpdateMsgVpnJndiQueueQueries queries) returns MsgVpnJndiQueueResponse|error

Update a JNDI Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The JNDI name of the JMS Queue.

payload MsgVpnJndiQueue - The JNDI Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnJndiQueueQueries - Queries to be sent with the request

Return Type

MsgVpnJndiQueueResponse|error - The JNDI Queue object's attributes after being updated, and the request metadata.

getMsgVpnJndiTopics

Isolated FunctionRemote Function

function getMsgVpnJndiTopics(string msgVpnName, map<string|string[]> headers, *GetMsgVpnJndiTopicsQueries queries) returns MsgVpnJndiTopicsResponse|error

Get a list of JNDI Topic objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiTopicsQueries - Queries to be sent with the request

Return Type

MsgVpnJndiTopicsResponse|error - The list of JNDI Topic objects' attributes, and the request metadata.

createMsgVpnJndiTopic

Isolated FunctionRemote Function

function createMsgVpnJndiTopic(string msgVpnName, MsgVpnJndiTopic payload, map<string|string[]> headers, *CreateMsgVpnJndiTopicQueries queries) returns MsgVpnJndiTopicResponse|error

Create a JNDI Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnJndiTopic - The JNDI Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnJndiTopicQueries - Queries to be sent with the request

Return Type

MsgVpnJndiTopicResponse|error - The JNDI Topic object's attributes after being created, and the request metadata.

getMsgVpnJndiTopic

Isolated FunctionRemote Function

function getMsgVpnJndiTopic(string msgVpnName, string topicName, map<string|string[]> headers, *GetMsgVpnJndiTopicQueries queries) returns MsgVpnJndiTopicResponse|error

Get a JNDI Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

topicName string - The JNDI name of the JMS Topic.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnJndiTopicQueries - Queries to be sent with the request

Return Type

MsgVpnJndiTopicResponse|error - The JNDI Topic object's attributes, and the request metadata.

replaceMsgVpnJndiTopic

Isolated FunctionRemote Function

function replaceMsgVpnJndiTopic(string msgVpnName, string topicName, MsgVpnJndiTopic payload, map<string|string[]> headers, *ReplaceMsgVpnJndiTopicQueries queries) returns MsgVpnJndiTopicResponse|error

Replace a JNDI Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

topicName string - The JNDI name of the JMS Topic.

payload MsgVpnJndiTopic - The JNDI Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnJndiTopicQueries - Queries to be sent with the request

Return Type

MsgVpnJndiTopicResponse|error - The JNDI Topic object's attributes after being replaced, and the request metadata.

deleteMsgVpnJndiTopic

Isolated FunctionRemote Function

function deleteMsgVpnJndiTopic(string msgVpnName, string topicName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a JNDI Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

topicName string - The JNDI name of the JMS Topic.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnJndiTopic

Isolated FunctionRemote Function

function updateMsgVpnJndiTopic(string msgVpnName, string topicName, MsgVpnJndiTopic payload, map<string|string[]> headers, *UpdateMsgVpnJndiTopicQueries queries) returns MsgVpnJndiTopicResponse|error

Update a JNDI Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

topicName string - The JNDI name of the JMS Topic.

payload MsgVpnJndiTopic - The JNDI Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnJndiTopicQueries - Queries to be sent with the request

Return Type

MsgVpnJndiTopicResponse|error - The JNDI Topic object's attributes after being updated, and the request metadata.

getMsgVpnKafkaReceivers

Isolated FunctionRemote Function

function getMsgVpnKafkaReceivers(string msgVpnName, map<string|string[]> headers, *GetMsgVpnKafkaReceiversQueries queries) returns MsgVpnKafkaReceiversResponse|error

Get a list of Kafka Receiver objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaReceiversQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiversResponse|error - The list of Kafka Receiver objects' attributes, and the request metadata.

createMsgVpnKafkaReceiver

Isolated FunctionRemote Function

function createMsgVpnKafkaReceiver(string msgVpnName, MsgVpnKafkaReceiver payload, map<string|string[]> headers, *CreateMsgVpnKafkaReceiverQueries queries) returns MsgVpnKafkaReceiverResponse|error

Create a Kafka Receiver object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnKafkaReceiver - The Kafka Receiver object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnKafkaReceiverQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverResponse|error - The Kafka Receiver object's attributes after being created, and the request metadata.

getMsgVpnKafkaReceiver

Isolated FunctionRemote Function

function getMsgVpnKafkaReceiver(string msgVpnName, string kafkaReceiverName, map<string|string[]> headers, *GetMsgVpnKafkaReceiverQueries queries) returns MsgVpnKafkaReceiverResponse|error

Get a Kafka Receiver object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaReceiverQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverResponse|error - The Kafka Receiver object's attributes, and the request metadata.

replaceMsgVpnKafkaReceiver

Isolated FunctionRemote Function

function replaceMsgVpnKafkaReceiver(string msgVpnName, string kafkaReceiverName, MsgVpnKafkaReceiver payload, map<string|string[]> headers, *ReplaceMsgVpnKafkaReceiverQueries queries) returns MsgVpnKafkaReceiverResponse|error

Replace a Kafka Receiver object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

payload MsgVpnKafkaReceiver - The Kafka Receiver object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnKafkaReceiverQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverResponse|error - The Kafka Receiver object's attributes after being replaced, and the request metadata.

deleteMsgVpnKafkaReceiver

Isolated FunctionRemote Function

function deleteMsgVpnKafkaReceiver(string msgVpnName, string kafkaReceiverName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Kafka Receiver object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnKafkaReceiver

Isolated FunctionRemote Function

function updateMsgVpnKafkaReceiver(string msgVpnName, string kafkaReceiverName, MsgVpnKafkaReceiver payload, map<string|string[]> headers, *UpdateMsgVpnKafkaReceiverQueries queries) returns MsgVpnKafkaReceiverResponse|error

Update a Kafka Receiver object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

payload MsgVpnKafkaReceiver - The Kafka Receiver object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnKafkaReceiverQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverResponse|error - The Kafka Receiver object's attributes after being updated, and the request metadata.

getMsgVpnKafkaReceiverTopicBindings

Isolated FunctionRemote Function

function getMsgVpnKafkaReceiverTopicBindings(string msgVpnName, string kafkaReceiverName, map<string|string[]> headers, *GetMsgVpnKafkaReceiverTopicBindingsQueries queries) returns MsgVpnKafkaReceiverTopicBindingsResponse|error

Get a list of Topic Binding objects.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaReceiverTopicBindingsQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverTopicBindingsResponse|error - The list of Topic Binding objects' attributes, and the request metadata.

createMsgVpnKafkaReceiverTopicBinding

Isolated FunctionRemote Function

function createMsgVpnKafkaReceiverTopicBinding(string msgVpnName, string kafkaReceiverName, MsgVpnKafkaReceiverTopicBinding payload, map<string|string[]> headers, *CreateMsgVpnKafkaReceiverTopicBindingQueries queries) returns MsgVpnKafkaReceiverTopicBindingResponse|error

Create a Topic Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

payload MsgVpnKafkaReceiverTopicBinding - The Topic Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnKafkaReceiverTopicBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverTopicBindingResponse|error - The Topic Binding object's attributes after being created, and the request metadata.

getMsgVpnKafkaReceiverTopicBinding

Isolated FunctionRemote Function

function getMsgVpnKafkaReceiverTopicBinding(string msgVpnName, string kafkaReceiverName, string topicName, map<string|string[]> headers, *GetMsgVpnKafkaReceiverTopicBindingQueries queries) returns MsgVpnKafkaReceiverTopicBindingResponse|error

Get a Topic Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

topicName string - The name of the Topic or a POSIX.2 regular expression starting with '^'.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaReceiverTopicBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverTopicBindingResponse|error - The Topic Binding object's attributes, and the request metadata.

replaceMsgVpnKafkaReceiverTopicBinding

Isolated FunctionRemote Function

function replaceMsgVpnKafkaReceiverTopicBinding(string msgVpnName, string kafkaReceiverName, string topicName, MsgVpnKafkaReceiverTopicBinding payload, map<string|string[]> headers, *ReplaceMsgVpnKafkaReceiverTopicBindingQueries queries) returns MsgVpnKafkaReceiverTopicBindingResponse|error

Replace a Topic Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

topicName string - The name of the Topic or a POSIX.2 regular expression starting with '^'.

payload MsgVpnKafkaReceiverTopicBinding - The Topic Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnKafkaReceiverTopicBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverTopicBindingResponse|error - The Topic Binding object's attributes after being replaced, and the request metadata.

deleteMsgVpnKafkaReceiverTopicBinding

Isolated FunctionRemote Function

function deleteMsgVpnKafkaReceiverTopicBinding(string msgVpnName, string kafkaReceiverName, string topicName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

topicName string - The name of the Topic or a POSIX.2 regular expression starting with '^'.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnKafkaReceiverTopicBinding

Isolated FunctionRemote Function

function updateMsgVpnKafkaReceiverTopicBinding(string msgVpnName, string kafkaReceiverName, string topicName, MsgVpnKafkaReceiverTopicBinding payload, map<string|string[]> headers, *UpdateMsgVpnKafkaReceiverTopicBindingQueries queries) returns MsgVpnKafkaReceiverTopicBindingResponse|error

Update a Topic Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaReceiverName string - The name of the Kafka Receiver.

topicName string - The name of the Topic or a POSIX.2 regular expression starting with '^'.

payload MsgVpnKafkaReceiverTopicBinding - The Topic Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnKafkaReceiverTopicBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaReceiverTopicBindingResponse|error - The Topic Binding object's attributes after being updated, and the request metadata.

getMsgVpnKafkaSenders

Isolated FunctionRemote Function

function getMsgVpnKafkaSenders(string msgVpnName, map<string|string[]> headers, *GetMsgVpnKafkaSendersQueries queries) returns MsgVpnKafkaSendersResponse|error

Get a list of Kafka Sender objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaSendersQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSendersResponse|error - The list of Kafka Sender objects' attributes, and the request metadata.

createMsgVpnKafkaSender

Isolated FunctionRemote Function

function createMsgVpnKafkaSender(string msgVpnName, MsgVpnKafkaSender payload, map<string|string[]> headers, *CreateMsgVpnKafkaSenderQueries queries) returns MsgVpnKafkaSenderResponse|error

Create a Kafka Sender object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnKafkaSender - The Kafka Sender object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnKafkaSenderQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderResponse|error - The Kafka Sender object's attributes after being created, and the request metadata.

getMsgVpnKafkaSender

Isolated FunctionRemote Function

function getMsgVpnKafkaSender(string msgVpnName, string kafkaSenderName, map<string|string[]> headers, *GetMsgVpnKafkaSenderQueries queries) returns MsgVpnKafkaSenderResponse|error

Get a Kafka Sender object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaSenderQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderResponse|error - The Kafka Sender object's attributes, and the request metadata.

replaceMsgVpnKafkaSender

Isolated FunctionRemote Function

function replaceMsgVpnKafkaSender(string msgVpnName, string kafkaSenderName, MsgVpnKafkaSender payload, map<string|string[]> headers, *ReplaceMsgVpnKafkaSenderQueries queries) returns MsgVpnKafkaSenderResponse|error

Replace a Kafka Sender object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

payload MsgVpnKafkaSender - The Kafka Sender object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnKafkaSenderQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderResponse|error - The Kafka Sender object's attributes after being replaced, and the request metadata.

deleteMsgVpnKafkaSender

Isolated FunctionRemote Function

function deleteMsgVpnKafkaSender(string msgVpnName, string kafkaSenderName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Kafka Sender object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnKafkaSender

Isolated FunctionRemote Function

function updateMsgVpnKafkaSender(string msgVpnName, string kafkaSenderName, MsgVpnKafkaSender payload, map<string|string[]> headers, *UpdateMsgVpnKafkaSenderQueries queries) returns MsgVpnKafkaSenderResponse|error

Update a Kafka Sender object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

payload MsgVpnKafkaSender - The Kafka Sender object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnKafkaSenderQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderResponse|error - The Kafka Sender object's attributes after being updated, and the request metadata.

getMsgVpnKafkaSenderQueueBindings

Isolated FunctionRemote Function

function getMsgVpnKafkaSenderQueueBindings(string msgVpnName, string kafkaSenderName, map<string|string[]> headers, *GetMsgVpnKafkaSenderQueueBindingsQueries queries) returns MsgVpnKafkaSenderQueueBindingsResponse|error

Get a list of Queue Binding objects.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaSenderQueueBindingsQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderQueueBindingsResponse|error - The list of Queue Binding objects' attributes, and the request metadata.

createMsgVpnKafkaSenderQueueBinding

Isolated FunctionRemote Function

function createMsgVpnKafkaSenderQueueBinding(string msgVpnName, string kafkaSenderName, MsgVpnKafkaSenderQueueBinding payload, map<string|string[]> headers, *CreateMsgVpnKafkaSenderQueueBindingQueries queries) returns MsgVpnKafkaSenderQueueBindingResponse|error

Create a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

payload MsgVpnKafkaSenderQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnKafkaSenderQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderQueueBindingResponse|error - The Queue Binding object's attributes after being created, and the request metadata.

getMsgVpnKafkaSenderQueueBinding

Isolated FunctionRemote Function

function getMsgVpnKafkaSenderQueueBinding(string msgVpnName, string kafkaSenderName, string queueName, map<string|string[]> headers, *GetMsgVpnKafkaSenderQueueBindingQueries queries) returns MsgVpnKafkaSenderQueueBindingResponse|error

Get a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

queueName string - The name of the Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnKafkaSenderQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderQueueBindingResponse|error - The Queue Binding object's attributes, and the request metadata.

replaceMsgVpnKafkaSenderQueueBinding

Isolated FunctionRemote Function

function replaceMsgVpnKafkaSenderQueueBinding(string msgVpnName, string kafkaSenderName, string queueName, MsgVpnKafkaSenderQueueBinding payload, map<string|string[]> headers, *ReplaceMsgVpnKafkaSenderQueueBindingQueries queries) returns MsgVpnKafkaSenderQueueBindingResponse|error

Replace a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

queueName string - The name of the Queue.

payload MsgVpnKafkaSenderQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnKafkaSenderQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderQueueBindingResponse|error - The Queue Binding object's attributes after being replaced, and the request metadata.

deleteMsgVpnKafkaSenderQueueBinding

Isolated FunctionRemote Function

function deleteMsgVpnKafkaSenderQueueBinding(string msgVpnName, string kafkaSenderName, string queueName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

queueName string - The name of the Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnKafkaSenderQueueBinding

Isolated FunctionRemote Function

function updateMsgVpnKafkaSenderQueueBinding(string msgVpnName, string kafkaSenderName, string queueName, MsgVpnKafkaSenderQueueBinding payload, map<string|string[]> headers, *UpdateMsgVpnKafkaSenderQueueBindingQueries queries) returns MsgVpnKafkaSenderQueueBindingResponse|error

Update a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

kafkaSenderName string - The name of the Kafka Sender.

queueName string - The name of the Queue.

payload MsgVpnKafkaSenderQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnKafkaSenderQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnKafkaSenderQueueBindingResponse|error - The Queue Binding object's attributes after being updated, and the request metadata.

getMsgVpnMqttRetainCaches

Isolated FunctionRemote Function

function getMsgVpnMqttRetainCaches(string msgVpnName, map<string|string[]> headers, *GetMsgVpnMqttRetainCachesQueries queries) returns MsgVpnMqttRetainCachesResponse|error

Get a list of MQTT Retain Cache objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttRetainCachesQueries - Queries to be sent with the request

Return Type

MsgVpnMqttRetainCachesResponse|error - The list of MQTT Retain Cache objects' attributes, and the request metadata.

createMsgVpnMqttRetainCache

Isolated FunctionRemote Function

function createMsgVpnMqttRetainCache(string msgVpnName, MsgVpnMqttRetainCache payload, map<string|string[]> headers, *CreateMsgVpnMqttRetainCacheQueries queries) returns MsgVpnMqttRetainCacheResponse|error

Create an MQTT Retain Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnMqttRetainCache - The MQTT Retain Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnMqttRetainCacheQueries - Queries to be sent with the request

Return Type

MsgVpnMqttRetainCacheResponse|error - The MQTT Retain Cache object's attributes after being created, and the request metadata.

getMsgVpnMqttRetainCache

Isolated FunctionRemote Function

function getMsgVpnMqttRetainCache(string msgVpnName, string cacheName, map<string|string[]> headers, *GetMsgVpnMqttRetainCacheQueries queries) returns MsgVpnMqttRetainCacheResponse|error

Get an MQTT Retain Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the MQTT Retain Cache.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttRetainCacheQueries - Queries to be sent with the request

Return Type

MsgVpnMqttRetainCacheResponse|error - The MQTT Retain Cache object's attributes, and the request metadata.

replaceMsgVpnMqttRetainCache

Isolated FunctionRemote Function

function replaceMsgVpnMqttRetainCache(string msgVpnName, string cacheName, MsgVpnMqttRetainCache payload, map<string|string[]> headers, *ReplaceMsgVpnMqttRetainCacheQueries queries) returns MsgVpnMqttRetainCacheResponse|error

Replace an MQTT Retain Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the MQTT Retain Cache.

payload MsgVpnMqttRetainCache - The MQTT Retain Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnMqttRetainCacheQueries - Queries to be sent with the request

Return Type

MsgVpnMqttRetainCacheResponse|error - The MQTT Retain Cache object's attributes after being replaced, and the request metadata.

deleteMsgVpnMqttRetainCache

Isolated FunctionRemote Function

function deleteMsgVpnMqttRetainCache(string msgVpnName, string cacheName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an MQTT Retain Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the MQTT Retain Cache.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnMqttRetainCache

Isolated FunctionRemote Function

function updateMsgVpnMqttRetainCache(string msgVpnName, string cacheName, MsgVpnMqttRetainCache payload, map<string|string[]> headers, *UpdateMsgVpnMqttRetainCacheQueries queries) returns MsgVpnMqttRetainCacheResponse|error

Update an MQTT Retain Cache object.

Parameters

msgVpnName string - The name of the Message VPN.

cacheName string - The name of the MQTT Retain Cache.

payload MsgVpnMqttRetainCache - The MQTT Retain Cache object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnMqttRetainCacheQueries - Queries to be sent with the request

Return Type

MsgVpnMqttRetainCacheResponse|error - The MQTT Retain Cache object's attributes after being updated, and the request metadata.

getMsgVpnMqttSessions

Isolated FunctionRemote Function

function getMsgVpnMqttSessions(string msgVpnName, map<string|string[]> headers, *GetMsgVpnMqttSessionsQueries queries) returns MsgVpnMqttSessionsResponse|error

Get a list of MQTT Session objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttSessionsQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionsResponse|error - The list of MQTT Session objects' attributes, and the request metadata.

createMsgVpnMqttSession

Isolated FunctionRemote Function

function createMsgVpnMqttSession(string msgVpnName, MsgVpnMqttSession payload, map<string|string[]> headers, *CreateMsgVpnMqttSessionQueries queries) returns MsgVpnMqttSessionResponse|error

Create an MQTT Session object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnMqttSession - The MQTT Session object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnMqttSessionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionResponse|error - The MQTT Session object's attributes after being created, and the request metadata.

getMsgVpnMqttSession

Isolated FunctionRemote Function

function getMsgVpnMqttSession(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, map<string|string[]> headers, *GetMsgVpnMqttSessionQueries queries) returns MsgVpnMqttSessionResponse|error

Get an MQTT Session object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttSessionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionResponse|error - The MQTT Session object's attributes, and the request metadata.

replaceMsgVpnMqttSession

Isolated FunctionRemote Function

function replaceMsgVpnMqttSession(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, MsgVpnMqttSession payload, map<string|string[]> headers, *ReplaceMsgVpnMqttSessionQueries queries) returns MsgVpnMqttSessionResponse|error

Replace an MQTT Session object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

payload MsgVpnMqttSession - The MQTT Session object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnMqttSessionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionResponse|error - The MQTT Session object's attributes after being replaced, and the request metadata.

deleteMsgVpnMqttSession

Isolated FunctionRemote Function

function deleteMsgVpnMqttSession(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an MQTT Session object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnMqttSession

Isolated FunctionRemote Function

function updateMsgVpnMqttSession(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, MsgVpnMqttSession payload, map<string|string[]> headers, *UpdateMsgVpnMqttSessionQueries queries) returns MsgVpnMqttSessionResponse|error

Update an MQTT Session object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

payload MsgVpnMqttSession - The MQTT Session object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnMqttSessionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionResponse|error - The MQTT Session object's attributes after being updated, and the request metadata.

getMsgVpnMqttSessionSubscriptions

Isolated FunctionRemote Function

function getMsgVpnMqttSessionSubscriptions(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, map<string|string[]> headers, *GetMsgVpnMqttSessionSubscriptionsQueries queries) returns MsgVpnMqttSessionSubscriptionsResponse|error

Get a list of Subscription objects.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttSessionSubscriptionsQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionSubscriptionsResponse|error - The list of Subscription objects' attributes, and the request metadata.

createMsgVpnMqttSessionSubscription

Isolated FunctionRemote Function

function createMsgVpnMqttSessionSubscription(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription payload, map<string|string[]> headers, *CreateMsgVpnMqttSessionSubscriptionQueries queries) returns MsgVpnMqttSessionSubscriptionResponse|error

Create a Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

payload MsgVpnMqttSessionSubscription - The Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnMqttSessionSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionSubscriptionResponse|error - The Subscription object's attributes after being created, and the request metadata.

getMsgVpnMqttSessionSubscription

Isolated FunctionRemote Function

function getMsgVpnMqttSessionSubscription(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, string subscriptionTopic, map<string|string[]> headers, *GetMsgVpnMqttSessionSubscriptionQueries queries) returns MsgVpnMqttSessionSubscriptionResponse|error

Get a Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

subscriptionTopic string - The MQTT subscription topic.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnMqttSessionSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionSubscriptionResponse|error - The Subscription object's attributes, and the request metadata.

replaceMsgVpnMqttSessionSubscription

Isolated FunctionRemote Function

function replaceMsgVpnMqttSessionSubscription(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, string subscriptionTopic, MsgVpnMqttSessionSubscription payload, map<string|string[]> headers, *ReplaceMsgVpnMqttSessionSubscriptionQueries queries) returns MsgVpnMqttSessionSubscriptionResponse|error

Replace a Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

subscriptionTopic string - The MQTT subscription topic.

payload MsgVpnMqttSessionSubscription - The Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnMqttSessionSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionSubscriptionResponse|error - The Subscription object's attributes after being replaced, and the request metadata.

deleteMsgVpnMqttSessionSubscription

Isolated FunctionRemote Function

function deleteMsgVpnMqttSessionSubscription(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, string subscriptionTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

subscriptionTopic string - The MQTT subscription topic.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnMqttSessionSubscription

Isolated FunctionRemote Function

function updateMsgVpnMqttSessionSubscription(string msgVpnName, string mqttSessionClientId, string mqttSessionVirtualRouter, string subscriptionTopic, MsgVpnMqttSessionSubscription payload, map<string|string[]> headers, *UpdateMsgVpnMqttSessionSubscriptionQueries queries) returns MsgVpnMqttSessionSubscriptionResponse|error

Update a Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

mqttSessionClientId string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

mqttSessionVirtualRouter string - The virtual router of the MQTT Session.

subscriptionTopic string - The MQTT subscription topic.

payload MsgVpnMqttSessionSubscription - The Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnMqttSessionSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnMqttSessionSubscriptionResponse|error - The Subscription object's attributes after being updated, and the request metadata.

getMsgVpnProxies

Isolated FunctionRemote Function

function getMsgVpnProxies(string msgVpnName, map<string|string[]> headers, *GetMsgVpnProxiesQueries queries) returns MsgVpnProxiesResponse|error

Get a list of Proxy objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnProxiesQueries - Queries to be sent with the request

Return Type

MsgVpnProxiesResponse|error - The list of Proxy objects' attributes, and the request metadata.

createMsgVpnProxy

Isolated FunctionRemote Function

function createMsgVpnProxy(string msgVpnName, MsgVpnProxy payload, map<string|string[]> headers, *CreateMsgVpnProxyQueries queries) returns MsgVpnProxyResponse|error

Create a Proxy object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnProxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnProxyQueries - Queries to be sent with the request

Return Type

MsgVpnProxyResponse|error - The Proxy object's attributes after being created, and the request metadata.

getMsgVpnProxy

Isolated FunctionRemote Function

function getMsgVpnProxy(string msgVpnName, string proxyName, map<string|string[]> headers, *GetMsgVpnProxyQueries queries) returns MsgVpnProxyResponse|error

Get a Proxy object.

Parameters

msgVpnName string - The name of the Message VPN.

proxyName string - The name of the proxy.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnProxyQueries - Queries to be sent with the request

Return Type

MsgVpnProxyResponse|error - The Proxy object's attributes, and the request metadata.

replaceMsgVpnProxy

Isolated FunctionRemote Function

function replaceMsgVpnProxy(string msgVpnName, string proxyName, MsgVpnProxy payload, map<string|string[]> headers, *ReplaceMsgVpnProxyQueries queries) returns MsgVpnProxyResponse|error

Replace a Proxy object.

Parameters

msgVpnName string - The name of the Message VPN.

proxyName string - The name of the proxy.

payload MsgVpnProxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnProxyQueries - Queries to be sent with the request

Return Type

MsgVpnProxyResponse|error - The Proxy object's attributes after being replaced, and the request metadata.

deleteMsgVpnProxy

Isolated FunctionRemote Function

function deleteMsgVpnProxy(string msgVpnName, string proxyName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Proxy object.

Parameters

msgVpnName string - The name of the Message VPN.

proxyName string - The name of the proxy.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnProxy

Isolated FunctionRemote Function

function updateMsgVpnProxy(string msgVpnName, string proxyName, MsgVpnProxy payload, map<string|string[]> headers, *UpdateMsgVpnProxyQueries queries) returns MsgVpnProxyResponse|error

Update a Proxy object.

Parameters

msgVpnName string - The name of the Message VPN.

proxyName string - The name of the proxy.

payload MsgVpnProxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnProxyQueries - Queries to be sent with the request

Return Type

MsgVpnProxyResponse|error - The Proxy object's attributes after being updated, and the request metadata.

getMsgVpnQueueTemplates

Isolated FunctionRemote Function

function getMsgVpnQueueTemplates(string msgVpnName, map<string|string[]> headers, *GetMsgVpnQueueTemplatesQueries queries) returns MsgVpnQueueTemplatesResponse|error

Get a list of Queue Template objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueueTemplatesQueries - Queries to be sent with the request

Return Type

MsgVpnQueueTemplatesResponse|error - The list of Queue Template objects' attributes, and the request metadata.

createMsgVpnQueueTemplate

Isolated FunctionRemote Function

function createMsgVpnQueueTemplate(string msgVpnName, MsgVpnQueueTemplate payload, map<string|string[]> headers, *CreateMsgVpnQueueTemplateQueries queries) returns MsgVpnQueueTemplateResponse|error

Create a Queue Template object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnQueueTemplate - The Queue Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnQueueTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnQueueTemplateResponse|error - The Queue Template object's attributes after being created, and the request metadata.

getMsgVpnQueueTemplate

Isolated FunctionRemote Function

function getMsgVpnQueueTemplate(string msgVpnName, string queueTemplateName, map<string|string[]> headers, *GetMsgVpnQueueTemplateQueries queries) returns MsgVpnQueueTemplateResponse|error

Get a Queue Template object.

Parameters

msgVpnName string - The name of the Message VPN.

queueTemplateName string - The name of the Queue Template.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueueTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnQueueTemplateResponse|error - The Queue Template object's attributes, and the request metadata.

replaceMsgVpnQueueTemplate

Isolated FunctionRemote Function

function replaceMsgVpnQueueTemplate(string msgVpnName, string queueTemplateName, MsgVpnQueueTemplate payload, map<string|string[]> headers, *ReplaceMsgVpnQueueTemplateQueries queries) returns MsgVpnQueueTemplateResponse|error

Replace a Queue Template object.

Parameters

msgVpnName string - The name of the Message VPN.

queueTemplateName string - The name of the Queue Template.

payload MsgVpnQueueTemplate - The Queue Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnQueueTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnQueueTemplateResponse|error - The Queue Template object's attributes after being replaced, and the request metadata.

deleteMsgVpnQueueTemplate

Isolated FunctionRemote Function

function deleteMsgVpnQueueTemplate(string msgVpnName, string queueTemplateName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Queue Template object.

Parameters

msgVpnName string - The name of the Message VPN.

queueTemplateName string - The name of the Queue Template.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnQueueTemplate

Isolated FunctionRemote Function

function updateMsgVpnQueueTemplate(string msgVpnName, string queueTemplateName, MsgVpnQueueTemplate payload, map<string|string[]> headers, *UpdateMsgVpnQueueTemplateQueries queries) returns MsgVpnQueueTemplateResponse|error

Update a Queue Template object.

Parameters

msgVpnName string - The name of the Message VPN.

queueTemplateName string - The name of the Queue Template.

payload MsgVpnQueueTemplate - The Queue Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnQueueTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnQueueTemplateResponse|error - The Queue Template object's attributes after being updated, and the request metadata.

getMsgVpnQueues

Isolated FunctionRemote Function

function getMsgVpnQueues(string msgVpnName, map<string|string[]> headers, *GetMsgVpnQueuesQueries queries) returns MsgVpnQueuesResponse|error

Get a list of Queue objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueuesQueries - Queries to be sent with the request

Return Type

MsgVpnQueuesResponse|error - The list of Queue objects' attributes, and the request metadata.

createMsgVpnQueue

Isolated FunctionRemote Function

function createMsgVpnQueue(string msgVpnName, MsgVpnQueue payload, map<string|string[]> headers, *CreateMsgVpnQueueQueries queries) returns MsgVpnQueueResponse|error

Create a Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnQueue - The Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnQueueQueries - Queries to be sent with the request

Return Type

MsgVpnQueueResponse|error - The Queue object's attributes after being created, and the request metadata.

getMsgVpnQueue

Isolated FunctionRemote Function

function getMsgVpnQueue(string msgVpnName, string queueName, map<string|string[]> headers, *GetMsgVpnQueueQueries queries) returns MsgVpnQueueResponse|error

Get a Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueueQueries - Queries to be sent with the request

Return Type

MsgVpnQueueResponse|error - The Queue object's attributes, and the request metadata.

replaceMsgVpnQueue

Isolated FunctionRemote Function

function replaceMsgVpnQueue(string msgVpnName, string queueName, MsgVpnQueue payload, map<string|string[]> headers, *ReplaceMsgVpnQueueQueries queries) returns MsgVpnQueueResponse|error

Replace a Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

payload MsgVpnQueue - The Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnQueueQueries - Queries to be sent with the request

Return Type

MsgVpnQueueResponse|error - The Queue object's attributes after being replaced, and the request metadata.

deleteMsgVpnQueue

Isolated FunctionRemote Function

function deleteMsgVpnQueue(string msgVpnName, string queueName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnQueue

Isolated FunctionRemote Function

function updateMsgVpnQueue(string msgVpnName, string queueName, MsgVpnQueue payload, map<string|string[]> headers, *UpdateMsgVpnQueueQueries queries) returns MsgVpnQueueResponse|error

Update a Queue object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

payload MsgVpnQueue - The Queue object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnQueueQueries - Queries to be sent with the request

Return Type

MsgVpnQueueResponse|error - The Queue object's attributes after being updated, and the request metadata.

getMsgVpnQueueSubscriptions

Isolated FunctionRemote Function

function getMsgVpnQueueSubscriptions(string msgVpnName, string queueName, map<string|string[]> headers, *GetMsgVpnQueueSubscriptionsQueries queries) returns MsgVpnQueueSubscriptionsResponse|error

Get a list of Queue Subscription objects.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueueSubscriptionsQueries - Queries to be sent with the request

Return Type

MsgVpnQueueSubscriptionsResponse|error - The list of Queue Subscription objects' attributes, and the request metadata.

createMsgVpnQueueSubscription

Isolated FunctionRemote Function

function createMsgVpnQueueSubscription(string msgVpnName, string queueName, MsgVpnQueueSubscription payload, map<string|string[]> headers, *CreateMsgVpnQueueSubscriptionQueries queries) returns MsgVpnQueueSubscriptionResponse|error

Create a Queue Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

payload MsgVpnQueueSubscription - The Queue Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnQueueSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnQueueSubscriptionResponse|error - The Queue Subscription object's attributes after being created, and the request metadata.

getMsgVpnQueueSubscription

Isolated FunctionRemote Function

function getMsgVpnQueueSubscription(string msgVpnName, string queueName, string subscriptionTopic, map<string|string[]> headers, *GetMsgVpnQueueSubscriptionQueries queries) returns MsgVpnQueueSubscriptionResponse|error

Get a Queue Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

subscriptionTopic string - The topic of the Subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnQueueSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnQueueSubscriptionResponse|error - The Queue Subscription object's attributes, and the request metadata.

deleteMsgVpnQueueSubscription

Isolated FunctionRemote Function

function deleteMsgVpnQueueSubscription(string msgVpnName, string queueName, string subscriptionTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Queue Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

queueName string - The name of the Queue.

subscriptionTopic string - The topic of the Subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnReplayLogs

Isolated FunctionRemote Function

function getMsgVpnReplayLogs(string msgVpnName, map<string|string[]> headers, *GetMsgVpnReplayLogsQueries queries) returns MsgVpnReplayLogsResponse|error

Get a list of Replay Log objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplayLogsQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogsResponse|error - The list of Replay Log objects' attributes, and the request metadata.

createMsgVpnReplayLog

Isolated FunctionRemote Function

function createMsgVpnReplayLog(string msgVpnName, MsgVpnReplayLog payload, map<string|string[]> headers, *CreateMsgVpnReplayLogQueries queries) returns MsgVpnReplayLogResponse|error

Create a Replay Log object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnReplayLog - The Replay Log object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnReplayLogQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogResponse|error - The Replay Log object's attributes after being created, and the request metadata.

getMsgVpnReplayLog

Isolated FunctionRemote Function

function getMsgVpnReplayLog(string msgVpnName, string replayLogName, map<string|string[]> headers, *GetMsgVpnReplayLogQueries queries) returns MsgVpnReplayLogResponse|error

Get a Replay Log object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplayLogQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogResponse|error - The Replay Log object's attributes, and the request metadata.

replaceMsgVpnReplayLog

Isolated FunctionRemote Function

function replaceMsgVpnReplayLog(string msgVpnName, string replayLogName, MsgVpnReplayLog payload, map<string|string[]> headers, *ReplaceMsgVpnReplayLogQueries queries) returns MsgVpnReplayLogResponse|error

Replace a Replay Log object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

payload MsgVpnReplayLog - The Replay Log object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnReplayLogQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogResponse|error - The Replay Log object's attributes after being replaced, and the request metadata.

deleteMsgVpnReplayLog

Isolated FunctionRemote Function

function deleteMsgVpnReplayLog(string msgVpnName, string replayLogName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Replay Log object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnReplayLog

Isolated FunctionRemote Function

function updateMsgVpnReplayLog(string msgVpnName, string replayLogName, MsgVpnReplayLog payload, map<string|string[]> headers, *UpdateMsgVpnReplayLogQueries queries) returns MsgVpnReplayLogResponse|error

Update a Replay Log object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

payload MsgVpnReplayLog - The Replay Log object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnReplayLogQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogResponse|error - The Replay Log object's attributes after being updated, and the request metadata.

getMsgVpnReplayLogTopicFilterSubscriptions

Isolated FunctionRemote Function

function getMsgVpnReplayLogTopicFilterSubscriptions(string msgVpnName, string replayLogName, map<string|string[]> headers, *GetMsgVpnReplayLogTopicFilterSubscriptionsQueries queries) returns MsgVpnReplayLogTopicFilterSubscriptionsResponse|error

Get a list of Topic Filter Subscription objects.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplayLogTopicFilterSubscriptionsQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogTopicFilterSubscriptionsResponse|error - The list of Topic Filter Subscription objects' attributes, and the request metadata.

createMsgVpnReplayLogTopicFilterSubscription

Isolated FunctionRemote Function

function createMsgVpnReplayLogTopicFilterSubscription(string msgVpnName, string replayLogName, MsgVpnReplayLogTopicFilterSubscription payload, map<string|string[]> headers, *CreateMsgVpnReplayLogTopicFilterSubscriptionQueries queries) returns MsgVpnReplayLogTopicFilterSubscriptionResponse|error

Create a Topic Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

payload MsgVpnReplayLogTopicFilterSubscription - The Topic Filter Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnReplayLogTopicFilterSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogTopicFilterSubscriptionResponse|error - The Topic Filter Subscription object's attributes after being created, and the request metadata.

getMsgVpnReplayLogTopicFilterSubscription

Isolated FunctionRemote Function

function getMsgVpnReplayLogTopicFilterSubscription(string msgVpnName, string replayLogName, string topicFilterSubscription, map<string|string[]> headers, *GetMsgVpnReplayLogTopicFilterSubscriptionQueries queries) returns MsgVpnReplayLogTopicFilterSubscriptionResponse|error

Get a Topic Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

topicFilterSubscription string - The topic of the Subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplayLogTopicFilterSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnReplayLogTopicFilterSubscriptionResponse|error - The Topic Filter Subscription object's attributes, and the request metadata.

deleteMsgVpnReplayLogTopicFilterSubscription

Isolated FunctionRemote Function

function deleteMsgVpnReplayLogTopicFilterSubscription(string msgVpnName, string replayLogName, string topicFilterSubscription, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

replayLogName string - The name of the Replay Log.

topicFilterSubscription string - The topic of the Subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnReplicatedTopics

Isolated FunctionRemote Function

function getMsgVpnReplicatedTopics(string msgVpnName, map<string|string[]> headers, *GetMsgVpnReplicatedTopicsQueries queries) returns MsgVpnReplicatedTopicsResponse|error

Get a list of Replicated Topic objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplicatedTopicsQueries - Queries to be sent with the request

Return Type

MsgVpnReplicatedTopicsResponse|error - The list of Replicated Topic objects' attributes, and the request metadata.

createMsgVpnReplicatedTopic

Isolated FunctionRemote Function

function createMsgVpnReplicatedTopic(string msgVpnName, MsgVpnReplicatedTopic payload, map<string|string[]> headers, *CreateMsgVpnReplicatedTopicQueries queries) returns MsgVpnReplicatedTopicResponse|error

Create a Replicated Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnReplicatedTopic - The Replicated Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnReplicatedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnReplicatedTopicResponse|error - The Replicated Topic object's attributes after being created, and the request metadata.

getMsgVpnReplicatedTopic

Isolated FunctionRemote Function

function getMsgVpnReplicatedTopic(string msgVpnName, string replicatedTopic, map<string|string[]> headers, *GetMsgVpnReplicatedTopicQueries queries) returns MsgVpnReplicatedTopicResponse|error

Get a Replicated Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

replicatedTopic string - The topic for applying replication. Published messages matching this topic will be replicated to the standby site.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnReplicatedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnReplicatedTopicResponse|error - The Replicated Topic object's attributes, and the request metadata.

replaceMsgVpnReplicatedTopic

Isolated FunctionRemote Function

function replaceMsgVpnReplicatedTopic(string msgVpnName, string replicatedTopic, MsgVpnReplicatedTopic payload, map<string|string[]> headers, *ReplaceMsgVpnReplicatedTopicQueries queries) returns MsgVpnReplicatedTopicResponse|error

Replace a Replicated Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

replicatedTopic string - The topic for applying replication. Published messages matching this topic will be replicated to the standby site.

payload MsgVpnReplicatedTopic - The Replicated Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnReplicatedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnReplicatedTopicResponse|error - The Replicated Topic object's attributes after being replaced, and the request metadata.

deleteMsgVpnReplicatedTopic

Isolated FunctionRemote Function

function deleteMsgVpnReplicatedTopic(string msgVpnName, string replicatedTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Replicated Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

replicatedTopic string - The topic for applying replication. Published messages matching this topic will be replicated to the standby site.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnReplicatedTopic

Isolated FunctionRemote Function

function updateMsgVpnReplicatedTopic(string msgVpnName, string replicatedTopic, MsgVpnReplicatedTopic payload, map<string|string[]> headers, *UpdateMsgVpnReplicatedTopicQueries queries) returns MsgVpnReplicatedTopicResponse|error

Update a Replicated Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

replicatedTopic string - The topic for applying replication. Published messages matching this topic will be replicated to the standby site.

payload MsgVpnReplicatedTopic - The Replicated Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnReplicatedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnReplicatedTopicResponse|error - The Replicated Topic object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPoints

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPoints(string msgVpnName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointsQueries queries) returns MsgVpnRestDeliveryPointsResponse|error

Get a list of REST Delivery Point objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointsQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointsResponse|error - The list of REST Delivery Point objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPoint

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPoint(string msgVpnName, MsgVpnRestDeliveryPoint payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointQueries queries) returns MsgVpnRestDeliveryPointResponse|error

Create a REST Delivery Point object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnRestDeliveryPoint - The REST Delivery Point object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointResponse|error - The REST Delivery Point object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPoint

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPoint(string msgVpnName, string restDeliveryPointName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueries queries) returns MsgVpnRestDeliveryPointResponse|error

Get a REST Delivery Point object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointResponse|error - The REST Delivery Point object's attributes, and the request metadata.

replaceMsgVpnRestDeliveryPoint

Isolated FunctionRemote Function

function replaceMsgVpnRestDeliveryPoint(string msgVpnName, string restDeliveryPointName, MsgVpnRestDeliveryPoint payload, map<string|string[]> headers, *ReplaceMsgVpnRestDeliveryPointQueries queries) returns MsgVpnRestDeliveryPointResponse|error

Replace a REST Delivery Point object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

payload MsgVpnRestDeliveryPoint - The REST Delivery Point object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnRestDeliveryPointQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointResponse|error - The REST Delivery Point object's attributes after being replaced, and the request metadata.

deleteMsgVpnRestDeliveryPoint

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPoint(string msgVpnName, string restDeliveryPointName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a REST Delivery Point object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnRestDeliveryPoint

Isolated FunctionRemote Function

function updateMsgVpnRestDeliveryPoint(string msgVpnName, string restDeliveryPointName, MsgVpnRestDeliveryPoint payload, map<string|string[]> headers, *UpdateMsgVpnRestDeliveryPointQueries queries) returns MsgVpnRestDeliveryPointResponse|error

Update a REST Delivery Point object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

payload MsgVpnRestDeliveryPoint - The REST Delivery Point object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnRestDeliveryPointQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointResponse|error - The REST Delivery Point object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPointQueueBindings

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBindings(string msgVpnName, string restDeliveryPointName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingsQueries queries) returns MsgVpnRestDeliveryPointQueueBindingsResponse|error

Get a list of Queue Binding objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingsQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingsResponse|error - The list of Queue Binding objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPointQueueBinding

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPointQueueBinding(string msgVpnName, string restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointQueueBindingQueries queries) returns MsgVpnRestDeliveryPointQueueBindingResponse|error

Create a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

payload MsgVpnRestDeliveryPointQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingResponse|error - The Queue Binding object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPointQueueBinding

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBinding(string msgVpnName, string restDeliveryPointName, string queueBindingName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingQueries queries) returns MsgVpnRestDeliveryPointQueueBindingResponse|error

Get a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingResponse|error - The Queue Binding object's attributes, and the request metadata.

replaceMsgVpnRestDeliveryPointQueueBinding

Isolated FunctionRemote Function

function replaceMsgVpnRestDeliveryPointQueueBinding(string msgVpnName, string restDeliveryPointName, string queueBindingName, MsgVpnRestDeliveryPointQueueBinding payload, map<string|string[]> headers, *ReplaceMsgVpnRestDeliveryPointQueueBindingQueries queries) returns MsgVpnRestDeliveryPointQueueBindingResponse|error

Replace a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

payload MsgVpnRestDeliveryPointQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnRestDeliveryPointQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingResponse|error - The Queue Binding object's attributes after being replaced, and the request metadata.

deleteMsgVpnRestDeliveryPointQueueBinding

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointQueueBinding(string msgVpnName, string restDeliveryPointName, string queueBindingName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnRestDeliveryPointQueueBinding

Isolated FunctionRemote Function

function updateMsgVpnRestDeliveryPointQueueBinding(string msgVpnName, string restDeliveryPointName, string queueBindingName, MsgVpnRestDeliveryPointQueueBinding payload, map<string|string[]> headers, *UpdateMsgVpnRestDeliveryPointQueueBindingQueries queries) returns MsgVpnRestDeliveryPointQueueBindingResponse|error

Update a Queue Binding object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

payload MsgVpnRestDeliveryPointQueueBinding - The Queue Binding object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnRestDeliveryPointQueueBindingQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingResponse|error - The Queue Binding object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaders

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaders(string msgVpnName, string restDeliveryPointName, string queueBindingName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersQueries queries) returns MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse|error

Get a list of Protected Request Header objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse|error - The list of Protected Request Header objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error

Create a Protected Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

payload MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader - The Protected Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error - The Protected Request Header object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error

Get a Protected Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the protected HTTP request header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error - The Protected Request Header object's attributes, and the request metadata.

replaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Isolated FunctionRemote Function

function replaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader payload, map<string|string[]> headers, *ReplaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error

Replace a Protected Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the protected HTTP request header.

payload MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader - The Protected Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error - The Protected Request Header object's attributes after being replaced, and the request metadata.

deleteMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Protected Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the protected HTTP request header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Isolated FunctionRemote Function

function updateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader payload, map<string|string[]> headers, *UpdateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error

Update a Protected Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the protected HTTP request header.

payload MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader - The Protected Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse|error - The Protected Request Header object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPointQueueBindingRequestHeaders

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(string msgVpnName, string restDeliveryPointName, string queueBindingName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingRequestHeadersQueries queries) returns MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse|error

Get a list of Request Header objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingRequestHeadersQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse|error - The list of Request Header objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPointQueueBindingRequestHeader

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPointQueueBindingRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error

Create a Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

payload MsgVpnRestDeliveryPointQueueBindingRequestHeader - The Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error - The Request Header object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPointQueueBindingRequestHeader

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointQueueBindingRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error

Get a Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the HTTP request header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error - The Request Header object's attributes, and the request metadata.

replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader

Isolated FunctionRemote Function

function replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader payload, map<string|string[]> headers, *ReplaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error

Replace a Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the HTTP request header.

payload MsgVpnRestDeliveryPointQueueBindingRequestHeader - The Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error - The Request Header object's attributes after being replaced, and the request metadata.

deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the HTTP request header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnRestDeliveryPointQueueBindingRequestHeader

Isolated FunctionRemote Function

function updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(string msgVpnName, string restDeliveryPointName, string queueBindingName, string headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader payload, map<string|string[]> headers, *UpdateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries queries) returns MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error

Update a Request Header object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

queueBindingName string - The name of a queue in the Message VPN.

headerName string - The name of the HTTP request header.

payload MsgVpnRestDeliveryPointQueueBindingRequestHeader - The Request Header object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse|error - The Request Header object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPointRestConsumers

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumers(string msgVpnName, string restDeliveryPointName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumersQueries queries) returns MsgVpnRestDeliveryPointRestConsumersResponse|error

Get a list of REST Consumer objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumersQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumersResponse|error - The list of REST Consumer objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPointRestConsumer

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPointRestConsumer(string msgVpnName, string restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointRestConsumerQueries queries) returns MsgVpnRestDeliveryPointRestConsumerResponse|error

Create a REST Consumer object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

payload MsgVpnRestDeliveryPointRestConsumer - The REST Consumer object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointRestConsumerQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerResponse|error - The REST Consumer object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPointRestConsumer

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumer(string msgVpnName, string restDeliveryPointName, string restConsumerName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumerQueries queries) returns MsgVpnRestDeliveryPointRestConsumerResponse|error

Get a REST Consumer object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumerQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerResponse|error - The REST Consumer object's attributes, and the request metadata.

replaceMsgVpnRestDeliveryPointRestConsumer

Isolated FunctionRemote Function

function replaceMsgVpnRestDeliveryPointRestConsumer(string msgVpnName, string restDeliveryPointName, string restConsumerName, MsgVpnRestDeliveryPointRestConsumer payload, map<string|string[]> headers, *ReplaceMsgVpnRestDeliveryPointRestConsumerQueries queries) returns MsgVpnRestDeliveryPointRestConsumerResponse|error

Replace a REST Consumer object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

payload MsgVpnRestDeliveryPointRestConsumer - The REST Consumer object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnRestDeliveryPointRestConsumerQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerResponse|error - The REST Consumer object's attributes after being replaced, and the request metadata.

deleteMsgVpnRestDeliveryPointRestConsumer

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointRestConsumer(string msgVpnName, string restDeliveryPointName, string restConsumerName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a REST Consumer object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnRestDeliveryPointRestConsumer

Isolated FunctionRemote Function

function updateMsgVpnRestDeliveryPointRestConsumer(string msgVpnName, string restDeliveryPointName, string restConsumerName, MsgVpnRestDeliveryPointRestConsumer payload, map<string|string[]> headers, *UpdateMsgVpnRestDeliveryPointRestConsumerQueries queries) returns MsgVpnRestDeliveryPointRestConsumerResponse|error

Update a REST Consumer object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

payload MsgVpnRestDeliveryPointRestConsumer - The REST Consumer object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnRestDeliveryPointRestConsumerQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerResponse|error - The REST Consumer object's attributes after being updated, and the request metadata.

getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(string msgVpnName, string restDeliveryPointName, string restConsumerName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsQueries queries) returns MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse|error

Get a list of Claim objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse|error - The list of Claim objects' attributes, and the request metadata.

createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Isolated FunctionRemote Function

function createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(string msgVpnName, string restDeliveryPointName, string restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries queries) returns MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse|error

Create a Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

payload MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - The Claim object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse|error - The Claim object's attributes after being created, and the request metadata.

getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Isolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(string msgVpnName, string restDeliveryPointName, string restConsumerName, string oauthJwtClaimName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries queries) returns MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse|error

Get a Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

oauthJwtClaimName string - The name of the additional claim. Cannot be "exp", "iat", or "jti".

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse|error - The Claim object's attributes, and the request metadata.

deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Isolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(string msgVpnName, string restDeliveryPointName, string restConsumerName, string oauthJwtClaimName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Claim object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

oauthJwtClaimName string - The name of the additional claim. Cannot be "exp", "iat", or "jti".

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames

DeprecatedIsolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(string msgVpnName, string restDeliveryPointName, string restConsumerName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesQueries queries) returns MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse|error

Get a list of Trusted Common Name objects.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse|error - The list of Trusted Common Name objects' attributes, and the request metadata.

Deprecated

createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(string msgVpnName, string restDeliveryPointName, string restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName payload, map<string|string[]> headers, *CreateMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries queries) returns MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse|error

Create a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

payload MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - The Trusted Common Name object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(string msgVpnName, string restDeliveryPointName, string restConsumerName, string tlsTrustedCommonName, map<string|string[]> headers, *GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries queries) returns MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse|error

Get a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries - Queries to be sent with the request

Return Type

MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse|error - The Trusted Common Name object's attributes, and the request metadata.

Deprecated

deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(string msgVpnName, string restDeliveryPointName, string restConsumerName, string tlsTrustedCommonName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Trusted Common Name object.

Parameters

msgVpnName string - The name of the Message VPN.

restDeliveryPointName string - The name of the REST Delivery Point.

restConsumerName string - The name of the REST Consumer.

tlsTrustedCommonName string - The expected trusted common name of the remote certificate.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getMsgVpnSequencedTopics

DeprecatedIsolated FunctionRemote Function

function getMsgVpnSequencedTopics(string msgVpnName, map<string|string[]> headers, *GetMsgVpnSequencedTopicsQueries queries) returns MsgVpnSequencedTopicsResponse|error

Get a list of Sequenced Topic objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnSequencedTopicsQueries - Queries to be sent with the request

Return Type

MsgVpnSequencedTopicsResponse|error - The list of Sequenced Topic objects' attributes, and the request metadata.

Deprecated

createMsgVpnSequencedTopic

DeprecatedIsolated FunctionRemote Function

function createMsgVpnSequencedTopic(string msgVpnName, MsgVpnSequencedTopic payload, map<string|string[]> headers, *CreateMsgVpnSequencedTopicQueries queries) returns MsgVpnSequencedTopicResponse|error

Create a Sequenced Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnSequencedTopic - The Sequenced Topic object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnSequencedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnSequencedTopicResponse|error - The Sequenced Topic object's attributes after being created, and the request metadata.

Deprecated

getMsgVpnSequencedTopic

DeprecatedIsolated FunctionRemote Function

function getMsgVpnSequencedTopic(string msgVpnName, string sequencedTopic, map<string|string[]> headers, *GetMsgVpnSequencedTopicQueries queries) returns MsgVpnSequencedTopicResponse|error

Get a Sequenced Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

sequencedTopic string - Topic for applying sequence numbers.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnSequencedTopicQueries - Queries to be sent with the request

Return Type

MsgVpnSequencedTopicResponse|error - The Sequenced Topic object's attributes, and the request metadata.

Deprecated

deleteMsgVpnSequencedTopic

DeprecatedIsolated FunctionRemote Function

function deleteMsgVpnSequencedTopic(string msgVpnName, string sequencedTopic, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Sequenced Topic object.

Parameters

msgVpnName string - The name of the Message VPN.

sequencedTopic string - Topic for applying sequence numbers.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

Deprecated

getMsgVpnTelemetryProfiles

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfiles(string msgVpnName, map<string|string[]> headers, *GetMsgVpnTelemetryProfilesQueries queries) returns MsgVpnTelemetryProfilesResponse|error

Get a list of Telemetry Profile objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfilesQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfilesResponse|error - The list of Telemetry Profile objects' attributes, and the request metadata.

createMsgVpnTelemetryProfile

Isolated FunctionRemote Function

function createMsgVpnTelemetryProfile(string msgVpnName, MsgVpnTelemetryProfile payload, map<string|string[]> headers, *CreateMsgVpnTelemetryProfileQueries queries) returns MsgVpnTelemetryProfileResponse|error

Create a Telemetry Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnTelemetryProfile - The Telemetry Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTelemetryProfileQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileResponse|error - The Telemetry Profile object's attributes after being created, and the request metadata.

getMsgVpnTelemetryProfile

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfile(string msgVpnName, string telemetryProfileName, map<string|string[]> headers, *GetMsgVpnTelemetryProfileQueries queries) returns MsgVpnTelemetryProfileResponse|error

Get a Telemetry Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileResponse|error - The Telemetry Profile object's attributes, and the request metadata.

replaceMsgVpnTelemetryProfile

Isolated FunctionRemote Function

function replaceMsgVpnTelemetryProfile(string msgVpnName, string telemetryProfileName, MsgVpnTelemetryProfile payload, map<string|string[]> headers, *ReplaceMsgVpnTelemetryProfileQueries queries) returns MsgVpnTelemetryProfileResponse|error

Replace a Telemetry Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

payload MsgVpnTelemetryProfile - The Telemetry Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnTelemetryProfileQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileResponse|error - The Telemetry Profile object's attributes after being replaced, and the request metadata.

deleteMsgVpnTelemetryProfile

Isolated FunctionRemote Function

function deleteMsgVpnTelemetryProfile(string msgVpnName, string telemetryProfileName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Telemetry Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnTelemetryProfile

Isolated FunctionRemote Function

function updateMsgVpnTelemetryProfile(string msgVpnName, string telemetryProfileName, MsgVpnTelemetryProfile payload, map<string|string[]> headers, *UpdateMsgVpnTelemetryProfileQueries queries) returns MsgVpnTelemetryProfileResponse|error

Update a Telemetry Profile object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

payload MsgVpnTelemetryProfile - The Telemetry Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnTelemetryProfileQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileResponse|error - The Telemetry Profile object's attributes after being updated, and the request metadata.

getMsgVpnTelemetryProfileReceiverAclConnectExceptions

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileReceiverAclConnectExceptions(string msgVpnName, string telemetryProfileName, map<string|string[]> headers, *GetMsgVpnTelemetryProfileReceiverAclConnectExceptionsQueries queries) returns MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse|error

Get a list of Receiver ACL Connect Exception objects.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileReceiverAclConnectExceptionsQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse|error - The list of Receiver ACL Connect Exception objects' attributes, and the request metadata.

createMsgVpnTelemetryProfileReceiverAclConnectException

Isolated FunctionRemote Function

function createMsgVpnTelemetryProfileReceiverAclConnectException(string msgVpnName, string telemetryProfileName, MsgVpnTelemetryProfileReceiverAclConnectException payload, map<string|string[]> headers, *CreateMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries queries) returns MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse|error

Create a Receiver ACL Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

payload MsgVpnTelemetryProfileReceiverAclConnectException - The Receiver ACL Connect Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse|error - The Receiver ACL Connect Exception object's attributes after being created, and the request metadata.

getMsgVpnTelemetryProfileReceiverAclConnectException

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileReceiverAclConnectException(string msgVpnName, string telemetryProfileName, string receiverAclConnectExceptionAddress, map<string|string[]> headers, *GetMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries queries) returns MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse|error

Get a Receiver ACL Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

receiverAclConnectExceptionAddress string - The IP address/netmask of the receiver connect exception in CIDR form.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse|error - The Receiver ACL Connect Exception object's attributes, and the request metadata.

deleteMsgVpnTelemetryProfileReceiverAclConnectException

Isolated FunctionRemote Function

function deleteMsgVpnTelemetryProfileReceiverAclConnectException(string msgVpnName, string telemetryProfileName, string receiverAclConnectExceptionAddress, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Receiver ACL Connect Exception object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

receiverAclConnectExceptionAddress string - The IP address/netmask of the receiver connect exception in CIDR form.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnTelemetryProfileTraceFilters

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileTraceFilters(string msgVpnName, string telemetryProfileName, map<string|string[]> headers, *GetMsgVpnTelemetryProfileTraceFiltersQueries queries) returns MsgVpnTelemetryProfileTraceFiltersResponse|error

Get a list of Trace Filter objects.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileTraceFiltersQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFiltersResponse|error - The list of Trace Filter objects' attributes, and the request metadata.

createMsgVpnTelemetryProfileTraceFilter

Isolated FunctionRemote Function

function createMsgVpnTelemetryProfileTraceFilter(string msgVpnName, string telemetryProfileName, MsgVpnTelemetryProfileTraceFilter payload, map<string|string[]> headers, *CreateMsgVpnTelemetryProfileTraceFilterQueries queries) returns MsgVpnTelemetryProfileTraceFilterResponse|error

Create a Trace Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

payload MsgVpnTelemetryProfileTraceFilter - The Trace Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTelemetryProfileTraceFilterQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterResponse|error - The Trace Filter object's attributes after being created, and the request metadata.

getMsgVpnTelemetryProfileTraceFilter

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileTraceFilter(string msgVpnName, string telemetryProfileName, string traceFilterName, map<string|string[]> headers, *GetMsgVpnTelemetryProfileTraceFilterQueries queries) returns MsgVpnTelemetryProfileTraceFilterResponse|error

Get a Trace Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileTraceFilterQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterResponse|error - The Trace Filter object's attributes, and the request metadata.

replaceMsgVpnTelemetryProfileTraceFilter

Isolated FunctionRemote Function

function replaceMsgVpnTelemetryProfileTraceFilter(string msgVpnName, string telemetryProfileName, string traceFilterName, MsgVpnTelemetryProfileTraceFilter payload, map<string|string[]> headers, *ReplaceMsgVpnTelemetryProfileTraceFilterQueries queries) returns MsgVpnTelemetryProfileTraceFilterResponse|error

Replace a Trace Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

payload MsgVpnTelemetryProfileTraceFilter - The Trace Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnTelemetryProfileTraceFilterQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterResponse|error - The Trace Filter object's attributes after being replaced, and the request metadata.

deleteMsgVpnTelemetryProfileTraceFilter

Isolated FunctionRemote Function

function deleteMsgVpnTelemetryProfileTraceFilter(string msgVpnName, string telemetryProfileName, string traceFilterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Trace Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnTelemetryProfileTraceFilter

Isolated FunctionRemote Function

function updateMsgVpnTelemetryProfileTraceFilter(string msgVpnName, string telemetryProfileName, string traceFilterName, MsgVpnTelemetryProfileTraceFilter payload, map<string|string[]> headers, *UpdateMsgVpnTelemetryProfileTraceFilterQueries queries) returns MsgVpnTelemetryProfileTraceFilterResponse|error

Update a Trace Filter object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

payload MsgVpnTelemetryProfileTraceFilter - The Trace Filter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnTelemetryProfileTraceFilterQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterResponse|error - The Trace Filter object's attributes after being updated, and the request metadata.

getMsgVpnTelemetryProfileTraceFilterSubscriptions

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileTraceFilterSubscriptions(string msgVpnName, string telemetryProfileName, string traceFilterName, map<string|string[]> headers, *GetMsgVpnTelemetryProfileTraceFilterSubscriptionsQueries queries) returns MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse|error

Get a list of Telemetry Trace Filter Subscription objects.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileTraceFilterSubscriptionsQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse|error - The list of Telemetry Trace Filter Subscription objects' attributes, and the request metadata.

createMsgVpnTelemetryProfileTraceFilterSubscription

Isolated FunctionRemote Function

function createMsgVpnTelemetryProfileTraceFilterSubscription(string msgVpnName, string telemetryProfileName, string traceFilterName, MsgVpnTelemetryProfileTraceFilterSubscription payload, map<string|string[]> headers, *CreateMsgVpnTelemetryProfileTraceFilterSubscriptionQueries queries) returns MsgVpnTelemetryProfileTraceFilterSubscriptionResponse|error

Create a Telemetry Trace Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

payload MsgVpnTelemetryProfileTraceFilterSubscription - The Telemetry Trace Filter Subscription object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTelemetryProfileTraceFilterSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterSubscriptionResponse|error - The Telemetry Trace Filter Subscription object's attributes after being created, and the request metadata.

getMsgVpnTelemetryProfileTraceFilterSubscription

Isolated FunctionRemote Function

function getMsgVpnTelemetryProfileTraceFilterSubscription(string msgVpnName, string telemetryProfileName, string traceFilterName, string subscription, string subscriptionSyntax, map<string|string[]> headers, *GetMsgVpnTelemetryProfileTraceFilterSubscriptionQueries queries) returns MsgVpnTelemetryProfileTraceFilterSubscriptionResponse|error

Get a Telemetry Trace Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

subscription string - Messages matching this subscription will follow this filter's configuration.

subscriptionSyntax string - The syntax of the trace filter subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTelemetryProfileTraceFilterSubscriptionQueries - Queries to be sent with the request

Return Type

MsgVpnTelemetryProfileTraceFilterSubscriptionResponse|error - The Telemetry Trace Filter Subscription object's attributes, and the request metadata.

deleteMsgVpnTelemetryProfileTraceFilterSubscription

Isolated FunctionRemote Function

function deleteMsgVpnTelemetryProfileTraceFilterSubscription(string msgVpnName, string telemetryProfileName, string traceFilterName, string subscription, string subscriptionSyntax, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Telemetry Trace Filter Subscription object.

Parameters

msgVpnName string - The name of the Message VPN.

telemetryProfileName string - The name of the Telemetry Profile.

traceFilterName string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug".

subscription string - Messages matching this subscription will follow this filter's configuration.

subscriptionSyntax string - The syntax of the trace filter subscription.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getMsgVpnTopicEndpointTemplates

Isolated FunctionRemote Function

function getMsgVpnTopicEndpointTemplates(string msgVpnName, map<string|string[]> headers, *GetMsgVpnTopicEndpointTemplatesQueries queries) returns MsgVpnTopicEndpointTemplatesResponse|error

Get a list of Topic Endpoint Template objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTopicEndpointTemplatesQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointTemplatesResponse|error - The list of Topic Endpoint Template objects' attributes, and the request metadata.

createMsgVpnTopicEndpointTemplate

Isolated FunctionRemote Function

function createMsgVpnTopicEndpointTemplate(string msgVpnName, MsgVpnTopicEndpointTemplate payload, map<string|string[]> headers, *CreateMsgVpnTopicEndpointTemplateQueries queries) returns MsgVpnTopicEndpointTemplateResponse|error

Create a Topic Endpoint Template object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnTopicEndpointTemplate - The Topic Endpoint Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTopicEndpointTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointTemplateResponse|error - The Topic Endpoint Template object's attributes after being created, and the request metadata.

getMsgVpnTopicEndpointTemplate

Isolated FunctionRemote Function

function getMsgVpnTopicEndpointTemplate(string msgVpnName, string topicEndpointTemplateName, map<string|string[]> headers, *GetMsgVpnTopicEndpointTemplateQueries queries) returns MsgVpnTopicEndpointTemplateResponse|error

Get a Topic Endpoint Template object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointTemplateName string - The name of the Topic Endpoint Template.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTopicEndpointTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointTemplateResponse|error - The Topic Endpoint Template object's attributes, and the request metadata.

replaceMsgVpnTopicEndpointTemplate

Isolated FunctionRemote Function

function replaceMsgVpnTopicEndpointTemplate(string msgVpnName, string topicEndpointTemplateName, MsgVpnTopicEndpointTemplate payload, map<string|string[]> headers, *ReplaceMsgVpnTopicEndpointTemplateQueries queries) returns MsgVpnTopicEndpointTemplateResponse|error

Replace a Topic Endpoint Template object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointTemplateName string - The name of the Topic Endpoint Template.

payload MsgVpnTopicEndpointTemplate - The Topic Endpoint Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnTopicEndpointTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointTemplateResponse|error - The Topic Endpoint Template object's attributes after being replaced, and the request metadata.

deleteMsgVpnTopicEndpointTemplate

Isolated FunctionRemote Function

function deleteMsgVpnTopicEndpointTemplate(string msgVpnName, string topicEndpointTemplateName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic Endpoint Template object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointTemplateName string - The name of the Topic Endpoint Template.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnTopicEndpointTemplate

Isolated FunctionRemote Function

function updateMsgVpnTopicEndpointTemplate(string msgVpnName, string topicEndpointTemplateName, MsgVpnTopicEndpointTemplate payload, map<string|string[]> headers, *UpdateMsgVpnTopicEndpointTemplateQueries queries) returns MsgVpnTopicEndpointTemplateResponse|error

Update a Topic Endpoint Template object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointTemplateName string - The name of the Topic Endpoint Template.

payload MsgVpnTopicEndpointTemplate - The Topic Endpoint Template object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnTopicEndpointTemplateQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointTemplateResponse|error - The Topic Endpoint Template object's attributes after being updated, and the request metadata.

getMsgVpnTopicEndpoints

Isolated FunctionRemote Function

function getMsgVpnTopicEndpoints(string msgVpnName, map<string|string[]> headers, *GetMsgVpnTopicEndpointsQueries queries) returns MsgVpnTopicEndpointsResponse|error

Get a list of Topic Endpoint objects.

Parameters

msgVpnName string - The name of the Message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTopicEndpointsQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointsResponse|error - The list of Topic Endpoint objects' attributes, and the request metadata.

createMsgVpnTopicEndpoint

Isolated FunctionRemote Function

function createMsgVpnTopicEndpoint(string msgVpnName, MsgVpnTopicEndpoint payload, map<string|string[]> headers, *CreateMsgVpnTopicEndpointQueries queries) returns MsgVpnTopicEndpointResponse|error

Create a Topic Endpoint object.

Parameters

msgVpnName string - The name of the Message VPN.

payload MsgVpnTopicEndpoint - The Topic Endpoint object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateMsgVpnTopicEndpointQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointResponse|error - The Topic Endpoint object's attributes after being created, and the request metadata.

getMsgVpnTopicEndpoint

Isolated FunctionRemote Function

function getMsgVpnTopicEndpoint(string msgVpnName, string topicEndpointName, map<string|string[]> headers, *GetMsgVpnTopicEndpointQueries queries) returns MsgVpnTopicEndpointResponse|error

Get a Topic Endpoint object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointName string - The name of the Topic Endpoint.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetMsgVpnTopicEndpointQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointResponse|error - The Topic Endpoint object's attributes, and the request metadata.

replaceMsgVpnTopicEndpoint

Isolated FunctionRemote Function

function replaceMsgVpnTopicEndpoint(string msgVpnName, string topicEndpointName, MsgVpnTopicEndpoint payload, map<string|string[]> headers, *ReplaceMsgVpnTopicEndpointQueries queries) returns MsgVpnTopicEndpointResponse|error

Replace a Topic Endpoint object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointName string - The name of the Topic Endpoint.

payload MsgVpnTopicEndpoint - The Topic Endpoint object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceMsgVpnTopicEndpointQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointResponse|error - The Topic Endpoint object's attributes after being replaced, and the request metadata.

deleteMsgVpnTopicEndpoint

Isolated FunctionRemote Function

function deleteMsgVpnTopicEndpoint(string msgVpnName, string topicEndpointName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Topic Endpoint object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointName string - The name of the Topic Endpoint.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateMsgVpnTopicEndpoint

Isolated FunctionRemote Function

function updateMsgVpnTopicEndpoint(string msgVpnName, string topicEndpointName, MsgVpnTopicEndpoint payload, map<string|string[]> headers, *UpdateMsgVpnTopicEndpointQueries queries) returns MsgVpnTopicEndpointResponse|error

Update a Topic Endpoint object.

Parameters

msgVpnName string - The name of the Message VPN.

topicEndpointName string - The name of the Topic Endpoint.

payload MsgVpnTopicEndpoint - The Topic Endpoint object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateMsgVpnTopicEndpointQueries - Queries to be sent with the request

Return Type

MsgVpnTopicEndpointResponse|error - The Topic Endpoint object's attributes after being updated, and the request metadata.

getOauthProfiles

Isolated FunctionRemote Function

function getOauthProfiles(map<string|string[]> headers, *GetOauthProfilesQueries queries) returns OauthProfilesResponse|error

Get a list of OAuth Profile objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfilesQueries - Queries to be sent with the request

Return Type

OauthProfilesResponse|error - The list of OAuth Profile objects' attributes, and the request metadata.

createOauthProfile

Isolated FunctionRemote Function

function createOauthProfile(OauthProfile payload, map<string|string[]> headers, *CreateOauthProfileQueries queries) returns OauthProfileResponse|error

Create an OAuth Profile object.

Parameters

payload OauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileQueries - Queries to be sent with the request

Return Type

OauthProfileResponse|error - The OAuth Profile object's attributes after being created, and the request metadata.

getOauthProfile

Isolated FunctionRemote Function

function getOauthProfile(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileQueries queries) returns OauthProfileResponse|error

Get an OAuth Profile object.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileQueries - Queries to be sent with the request

Return Type

OauthProfileResponse|error - The OAuth Profile object's attributes, and the request metadata.

replaceOauthProfile

Isolated FunctionRemote Function

function replaceOauthProfile(string oauthProfileName, OauthProfile payload, map<string|string[]> headers, *ReplaceOauthProfileQueries queries) returns OauthProfileResponse|error

Replace an OAuth Profile object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceOauthProfileQueries - Queries to be sent with the request

Return Type

OauthProfileResponse|error - The OAuth Profile object's attributes after being replaced, and the request metadata.

deleteOauthProfile

Isolated FunctionRemote Function

function deleteOauthProfile(string oauthProfileName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an OAuth Profile object.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateOauthProfile

Isolated FunctionRemote Function

function updateOauthProfile(string oauthProfileName, OauthProfile payload, map<string|string[]> headers, *UpdateOauthProfileQueries queries) returns OauthProfileResponse|error

Update an OAuth Profile object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfile - The OAuth Profile object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateOauthProfileQueries - Queries to be sent with the request

Return Type

OauthProfileResponse|error - The OAuth Profile object's attributes after being updated, and the request metadata.

getOauthProfileAccessLevelGroups

Isolated FunctionRemote Function

function getOauthProfileAccessLevelGroups(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileAccessLevelGroupsQueries queries) returns OauthProfileAccessLevelGroupsResponse|error

Get a list of Group Access Level objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileAccessLevelGroupsQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupsResponse|error - The list of Group Access Level objects' attributes, and the request metadata.

createOauthProfileAccessLevelGroup

Isolated FunctionRemote Function

function createOauthProfileAccessLevelGroup(string oauthProfileName, OauthProfileAccessLevelGroup payload, map<string|string[]> headers, *CreateOauthProfileAccessLevelGroupQueries queries) returns OauthProfileAccessLevelGroupResponse|error

Create a Group Access Level object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileAccessLevelGroup - The Group Access Level object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileAccessLevelGroupQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupResponse|error - The Group Access Level object's attributes after being created, and the request metadata.

getOauthProfileAccessLevelGroup

Isolated FunctionRemote Function

function getOauthProfileAccessLevelGroup(string oauthProfileName, string groupName, map<string|string[]> headers, *GetOauthProfileAccessLevelGroupQueries queries) returns OauthProfileAccessLevelGroupResponse|error

Get a Group Access Level object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileAccessLevelGroupQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupResponse|error - The Group Access Level object's attributes, and the request metadata.

replaceOauthProfileAccessLevelGroup

Isolated FunctionRemote Function

function replaceOauthProfileAccessLevelGroup(string oauthProfileName, string groupName, OauthProfileAccessLevelGroup payload, map<string|string[]> headers, *ReplaceOauthProfileAccessLevelGroupQueries queries) returns OauthProfileAccessLevelGroupResponse|error

Replace a Group Access Level object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

payload OauthProfileAccessLevelGroup - The Group Access Level object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceOauthProfileAccessLevelGroupQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupResponse|error - The Group Access Level object's attributes after being replaced, and the request metadata.

deleteOauthProfileAccessLevelGroup

Isolated FunctionRemote Function

function deleteOauthProfileAccessLevelGroup(string oauthProfileName, string groupName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Group Access Level object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateOauthProfileAccessLevelGroup

Isolated FunctionRemote Function

function updateOauthProfileAccessLevelGroup(string oauthProfileName, string groupName, OauthProfileAccessLevelGroup payload, map<string|string[]> headers, *UpdateOauthProfileAccessLevelGroupQueries queries) returns OauthProfileAccessLevelGroupResponse|error

Update a Group Access Level object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

payload OauthProfileAccessLevelGroup - The Group Access Level object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateOauthProfileAccessLevelGroupQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupResponse|error - The Group Access Level object's attributes after being updated, and the request metadata.

getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions

Isolated FunctionRemote Function

function getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(string oauthProfileName, string groupName, map<string|string[]> headers, *GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsQueries queries) returns OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse|error

Get a list of Message VPN Access-Level Exception objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse|error - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.

createOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Isolated FunctionRemote Function

function createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(string oauthProfileName, string groupName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException payload, map<string|string[]> headers, *CreateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error

Create a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

payload OauthProfileAccessLevelGroupMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.

getOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Isolated FunctionRemote Function

function getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(string oauthProfileName, string groupName, string msgVpnName, map<string|string[]> headers, *GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error

Get a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

msgVpnName string - The name of the message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes, and the request metadata.

replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Isolated FunctionRemote Function

function replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(string oauthProfileName, string groupName, string msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException payload, map<string|string[]> headers, *ReplaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error

Replace a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

msgVpnName string - The name of the message VPN.

payload OauthProfileAccessLevelGroupMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.

deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Isolated FunctionRemote Function

function deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(string oauthProfileName, string groupName, string msgVpnName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

msgVpnName string - The name of the message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Isolated FunctionRemote Function

function updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(string oauthProfileName, string groupName, string msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException payload, map<string|string[]> headers, *UpdateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error

Update a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

groupName string - The name of the group.

msgVpnName string - The name of the message VPN.

payload OauthProfileAccessLevelGroupMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.

getOauthProfileClientAllowedHosts

Isolated FunctionRemote Function

function getOauthProfileClientAllowedHosts(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileClientAllowedHostsQueries queries) returns OauthProfileClientAllowedHostsResponse|error

Get a list of Allowed Host Value objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientAllowedHostsQueries - Queries to be sent with the request

Return Type

OauthProfileClientAllowedHostsResponse|error - The list of Allowed Host Value objects' attributes, and the request metadata.

createOauthProfileClientAllowedHost

Isolated FunctionRemote Function

function createOauthProfileClientAllowedHost(string oauthProfileName, OauthProfileClientAllowedHost payload, map<string|string[]> headers, *CreateOauthProfileClientAllowedHostQueries queries) returns OauthProfileClientAllowedHostResponse|error

Create an Allowed Host Value object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileClientAllowedHost - The Allowed Host Value object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileClientAllowedHostQueries - Queries to be sent with the request

Return Type

OauthProfileClientAllowedHostResponse|error - The Allowed Host Value object's attributes after being created, and the request metadata.

getOauthProfileClientAllowedHost

Isolated FunctionRemote Function

function getOauthProfileClientAllowedHost(string oauthProfileName, string allowedHost, map<string|string[]> headers, *GetOauthProfileClientAllowedHostQueries queries) returns OauthProfileClientAllowedHostResponse|error

Get an Allowed Host Value object.

Parameters

oauthProfileName string - The name of the OAuth profile.

allowedHost string - An allowed value for the Host header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientAllowedHostQueries - Queries to be sent with the request

Return Type

OauthProfileClientAllowedHostResponse|error - The Allowed Host Value object's attributes, and the request metadata.

deleteOauthProfileClientAllowedHost

Isolated FunctionRemote Function

function deleteOauthProfileClientAllowedHost(string oauthProfileName, string allowedHost, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an Allowed Host Value object.

Parameters

oauthProfileName string - The name of the OAuth profile.

allowedHost string - An allowed value for the Host header.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getOauthProfileClientAuthorizationParameters

Isolated FunctionRemote Function

function getOauthProfileClientAuthorizationParameters(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileClientAuthorizationParametersQueries queries) returns OauthProfileClientAuthorizationParametersResponse|error

Get a list of Authorization Parameter objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientAuthorizationParametersQueries - Queries to be sent with the request

Return Type

OauthProfileClientAuthorizationParametersResponse|error - The list of Authorization Parameter objects' attributes, and the request metadata.

createOauthProfileClientAuthorizationParameter

Isolated FunctionRemote Function

function createOauthProfileClientAuthorizationParameter(string oauthProfileName, OauthProfileClientAuthorizationParameter payload, map<string|string[]> headers, *CreateOauthProfileClientAuthorizationParameterQueries queries) returns OauthProfileClientAuthorizationParameterResponse|error

Create an Authorization Parameter object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileClientAuthorizationParameter - The Authorization Parameter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileClientAuthorizationParameterQueries - Queries to be sent with the request

Return Type

OauthProfileClientAuthorizationParameterResponse|error - The Authorization Parameter object's attributes after being created, and the request metadata.

getOauthProfileClientAuthorizationParameter

Isolated FunctionRemote Function

function getOauthProfileClientAuthorizationParameter(string oauthProfileName, string authorizationParameterName, map<string|string[]> headers, *GetOauthProfileClientAuthorizationParameterQueries queries) returns OauthProfileClientAuthorizationParameterResponse|error

Get an Authorization Parameter object.

Parameters

oauthProfileName string - The name of the OAuth profile.

authorizationParameterName string - The name of the authorization parameter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientAuthorizationParameterQueries - Queries to be sent with the request

Return Type

OauthProfileClientAuthorizationParameterResponse|error - The Authorization Parameter object's attributes, and the request metadata.

replaceOauthProfileClientAuthorizationParameter

Isolated FunctionRemote Function

function replaceOauthProfileClientAuthorizationParameter(string oauthProfileName, string authorizationParameterName, OauthProfileClientAuthorizationParameter payload, map<string|string[]> headers, *ReplaceOauthProfileClientAuthorizationParameterQueries queries) returns OauthProfileClientAuthorizationParameterResponse|error

Replace an Authorization Parameter object.

Parameters

oauthProfileName string - The name of the OAuth profile.

authorizationParameterName string - The name of the authorization parameter.

payload OauthProfileClientAuthorizationParameter - The Authorization Parameter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceOauthProfileClientAuthorizationParameterQueries - Queries to be sent with the request

Return Type

OauthProfileClientAuthorizationParameterResponse|error - The Authorization Parameter object's attributes after being replaced, and the request metadata.

deleteOauthProfileClientAuthorizationParameter

Isolated FunctionRemote Function

function deleteOauthProfileClientAuthorizationParameter(string oauthProfileName, string authorizationParameterName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete an Authorization Parameter object.

Parameters

oauthProfileName string - The name of the OAuth profile.

authorizationParameterName string - The name of the authorization parameter.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateOauthProfileClientAuthorizationParameter

Isolated FunctionRemote Function

function updateOauthProfileClientAuthorizationParameter(string oauthProfileName, string authorizationParameterName, OauthProfileClientAuthorizationParameter payload, map<string|string[]> headers, *UpdateOauthProfileClientAuthorizationParameterQueries queries) returns OauthProfileClientAuthorizationParameterResponse|error

Update an Authorization Parameter object.

Parameters

oauthProfileName string - The name of the OAuth profile.

authorizationParameterName string - The name of the authorization parameter.

payload OauthProfileClientAuthorizationParameter - The Authorization Parameter object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateOauthProfileClientAuthorizationParameterQueries - Queries to be sent with the request

Return Type

OauthProfileClientAuthorizationParameterResponse|error - The Authorization Parameter object's attributes after being updated, and the request metadata.

getOauthProfileClientRequiredClaims

Isolated FunctionRemote Function

function getOauthProfileClientRequiredClaims(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileClientRequiredClaimsQueries queries) returns OauthProfileClientRequiredClaimsResponse|error

Get a list of Required Claim objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientRequiredClaimsQueries - Queries to be sent with the request

Return Type

OauthProfileClientRequiredClaimsResponse|error - The list of Required Claim objects' attributes, and the request metadata.

createOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function createOauthProfileClientRequiredClaim(string oauthProfileName, OauthProfileClientRequiredClaim payload, map<string|string[]> headers, *CreateOauthProfileClientRequiredClaimQueries queries) returns OauthProfileClientRequiredClaimResponse|error

Create a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileClientRequiredClaim - The Required Claim object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileClientRequiredClaimQueries - Queries to be sent with the request

Return Type

OauthProfileClientRequiredClaimResponse|error - The Required Claim object's attributes after being created, and the request metadata.

getOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function getOauthProfileClientRequiredClaim(string oauthProfileName, string clientRequiredClaimName, map<string|string[]> headers, *GetOauthProfileClientRequiredClaimQueries queries) returns OauthProfileClientRequiredClaimResponse|error

Get a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

clientRequiredClaimName string - The name of the ID token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileClientRequiredClaimQueries - Queries to be sent with the request

Return Type

OauthProfileClientRequiredClaimResponse|error - The Required Claim object's attributes, and the request metadata.

deleteOauthProfileClientRequiredClaim

Isolated FunctionRemote Function

function deleteOauthProfileClientRequiredClaim(string oauthProfileName, string clientRequiredClaimName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

clientRequiredClaimName string - The name of the ID token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getOauthProfileDefaultMsgVpnAccessLevelExceptions

Isolated FunctionRemote Function

function getOauthProfileDefaultMsgVpnAccessLevelExceptions(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileDefaultMsgVpnAccessLevelExceptionsQueries queries) returns OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse|error

Get a list of Message VPN Access-Level Exception objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileDefaultMsgVpnAccessLevelExceptionsQueries - Queries to be sent with the request

Return Type

OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse|error - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.

createOauthProfileDefaultMsgVpnAccessLevelException

Isolated FunctionRemote Function

function createOauthProfileDefaultMsgVpnAccessLevelException(string oauthProfileName, OauthProfileDefaultMsgVpnAccessLevelException payload, map<string|string[]> headers, *CreateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error

Create a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileDefaultMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.

getOauthProfileDefaultMsgVpnAccessLevelException

Isolated FunctionRemote Function

function getOauthProfileDefaultMsgVpnAccessLevelException(string oauthProfileName, string msgVpnName, map<string|string[]> headers, *GetOauthProfileDefaultMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error

Get a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

msgVpnName string - The name of the message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileDefaultMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes, and the request metadata.

replaceOauthProfileDefaultMsgVpnAccessLevelException

Isolated FunctionRemote Function

function replaceOauthProfileDefaultMsgVpnAccessLevelException(string oauthProfileName, string msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException payload, map<string|string[]> headers, *ReplaceOauthProfileDefaultMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error

Replace a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

msgVpnName string - The name of the message VPN.

payload OauthProfileDefaultMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceOauthProfileDefaultMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.

deleteOauthProfileDefaultMsgVpnAccessLevelException

Isolated FunctionRemote Function

function deleteOauthProfileDefaultMsgVpnAccessLevelException(string oauthProfileName, string msgVpnName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

msgVpnName string - The name of the message VPN.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateOauthProfileDefaultMsgVpnAccessLevelException

Isolated FunctionRemote Function

function updateOauthProfileDefaultMsgVpnAccessLevelException(string oauthProfileName, string msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException payload, map<string|string[]> headers, *UpdateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries queries) returns OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error

Update a Message VPN Access-Level Exception object.

Parameters

oauthProfileName string - The name of the OAuth profile.

msgVpnName string - The name of the message VPN.

payload OauthProfileDefaultMsgVpnAccessLevelException - The Message VPN Access-Level Exception object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries - Queries to be sent with the request

Return Type

OauthProfileDefaultMsgVpnAccessLevelExceptionResponse|error - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.

getOauthProfileResourceServerRequiredClaims

Isolated FunctionRemote Function

function getOauthProfileResourceServerRequiredClaims(string oauthProfileName, map<string|string[]> headers, *GetOauthProfileResourceServerRequiredClaimsQueries queries) returns OauthProfileResourceServerRequiredClaimsResponse|error

Get a list of Required Claim objects.

Parameters

oauthProfileName string - The name of the OAuth profile.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileResourceServerRequiredClaimsQueries - Queries to be sent with the request

Return Type

OauthProfileResourceServerRequiredClaimsResponse|error - The list of Required Claim objects' attributes, and the request metadata.

createOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function createOauthProfileResourceServerRequiredClaim(string oauthProfileName, OauthProfileResourceServerRequiredClaim payload, map<string|string[]> headers, *CreateOauthProfileResourceServerRequiredClaimQueries queries) returns OauthProfileResourceServerRequiredClaimResponse|error

Create a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

payload OauthProfileResourceServerRequiredClaim - The Required Claim object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateOauthProfileResourceServerRequiredClaimQueries - Queries to be sent with the request

Return Type

OauthProfileResourceServerRequiredClaimResponse|error - The Required Claim object's attributes after being created, and the request metadata.

getOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function getOauthProfileResourceServerRequiredClaim(string oauthProfileName, string resourceServerRequiredClaimName, map<string|string[]> headers, *GetOauthProfileResourceServerRequiredClaimQueries queries) returns OauthProfileResourceServerRequiredClaimResponse|error

Get a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

resourceServerRequiredClaimName string - The name of the access token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOauthProfileResourceServerRequiredClaimQueries - Queries to be sent with the request

Return Type

OauthProfileResourceServerRequiredClaimResponse|error - The Required Claim object's attributes, and the request metadata.

deleteOauthProfileResourceServerRequiredClaim

Isolated FunctionRemote Function

function deleteOauthProfileResourceServerRequiredClaim(string oauthProfileName, string resourceServerRequiredClaimName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Required Claim object.

Parameters

oauthProfileName string - The name of the OAuth profile.

resourceServerRequiredClaimName string - The name of the access token claim to verify.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

getProxies

Isolated FunctionRemote Function

function getProxies(map<string|string[]> headers, *GetProxiesQueries queries) returns ProxiesResponse|error

Get a list of Proxy objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetProxiesQueries - Queries to be sent with the request

Return Type

ProxiesResponse|error - The list of Proxy objects' attributes, and the request metadata.

createProxy

Isolated FunctionRemote Function

function createProxy(Proxy payload, map<string|string[]> headers, *CreateProxyQueries queries) returns ProxyResponse|error

Create a Proxy object.

Parameters

payload Proxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateProxyQueries - Queries to be sent with the request

Return Type

ProxyResponse|error - The Proxy object's attributes after being created, and the request metadata.

getProxy

Isolated FunctionRemote Function

function getProxy(string proxyName, map<string|string[]> headers, *GetProxyQueries queries) returns ProxyResponse|error

Get a Proxy object.

Parameters

proxyName string - The name of the proxy.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetProxyQueries - Queries to be sent with the request

Return Type

ProxyResponse|error - The Proxy object's attributes, and the request metadata.

replaceProxy

Isolated FunctionRemote Function

function replaceProxy(string proxyName, Proxy payload, map<string|string[]> headers, *ReplaceProxyQueries queries) returns ProxyResponse|error

Replace a Proxy object.

Parameters

proxyName string - The name of the proxy.

payload Proxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceProxyQueries - Queries to be sent with the request

Return Type

ProxyResponse|error - The Proxy object's attributes after being replaced, and the request metadata.

deleteProxy

Isolated FunctionRemote Function

function deleteProxy(string proxyName, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Proxy object.

Parameters

proxyName string - The name of the proxy.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateProxy

Isolated FunctionRemote Function

function updateProxy(string proxyName, Proxy payload, map<string|string[]> headers, *UpdateProxyQueries queries) returns ProxyResponse|error

Update a Proxy object.

Parameters

proxyName string - The name of the proxy.

payload Proxy - The Proxy object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateProxyQueries - Queries to be sent with the request

Return Type

ProxyResponse|error - The Proxy object's attributes after being updated, and the request metadata.

getSystemInformation

DeprecatedIsolated FunctionRemote Function

function getSystemInformation(map<string|string[]> headers, *GetSystemInformationQueries queries) returns SystemInformationResponse|error

Get a System Information object.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSystemInformationQueries - Queries to be sent with the request

Return Type

SystemInformationResponse|error - The System Information object's attributes, and the request metadata.

Deprecated

getVirtualHostnames

Isolated FunctionRemote Function

function getVirtualHostnames(map<string|string[]> headers, *GetVirtualHostnamesQueries queries) returns VirtualHostnamesResponse|error

Get a list of Virtual Hostname objects.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetVirtualHostnamesQueries - Queries to be sent with the request

Return Type

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

createVirtualHostname

Isolated FunctionRemote Function

function createVirtualHostname(VirtualHostname payload, map<string|string[]> headers, *CreateVirtualHostnameQueries queries) returns VirtualHostnameResponse|error

Create a Virtual Hostname object.

Parameters

payload VirtualHostname - The Virtual Hostname object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateVirtualHostnameQueries - Queries to be sent with the request

Return Type

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

getVirtualHostname

Isolated FunctionRemote Function

function getVirtualHostname(string virtualHostname, map<string|string[]> headers, *GetVirtualHostnameQueries queries) returns VirtualHostnameResponse|error

Get a Virtual Hostname object.

Parameters

virtualHostname string - The virtual hostname.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetVirtualHostnameQueries - Queries to be sent with the request

Return Type

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

replaceVirtualHostname

Isolated FunctionRemote Function

function replaceVirtualHostname(string virtualHostname, VirtualHostname payload, map<string|string[]> headers, *ReplaceVirtualHostnameQueries queries) returns VirtualHostnameResponse|error

Replace a Virtual Hostname object.

Parameters

virtualHostname string - The virtual hostname.

payload VirtualHostname - The Virtual Hostname object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ReplaceVirtualHostnameQueries - Queries to be sent with the request

Return Type

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

deleteVirtualHostname

Isolated FunctionRemote Function

function deleteVirtualHostname(string virtualHostname, map<string|string[]> headers) returns SempMetaOnlyResponse|error

Delete a Virtual Hostname object.

Parameters

virtualHostname string - The virtual hostname.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SempMetaOnlyResponse|error - The request metadata.

updateVirtualHostname

Isolated FunctionRemote Function

function updateVirtualHostname(string virtualHostname, VirtualHostname payload, map<string|string[]> headers, *UpdateVirtualHostnameQueries queries) returns VirtualHostnameResponse|error

Update a Virtual Hostname object.

Parameters

virtualHostname string - The virtual hostname.

payload VirtualHostname - The Virtual Hostname object's attributes.

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateVirtualHostnameQueries - Queries to be sent with the request

Return Type

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

Records

solace.semp: About

solace.semp: AboutApi

Fields

platform? string - The platform running the SEMP API. The minimum access scope/level required to retrieve this attribute is "global/none".

sempVersion? string - The version of the SEMP API. The minimum access scope/level required to retrieve this attribute is "global/none".

solace.semp: AboutApiLinks

Fields

uri? string - The URI of this API Description object.

solace.semp: AboutApiResponse

Fields

data? AboutApi -

links? AboutApiLinks -

meta SempMeta -

solace.semp: AboutLinks

Fields

apiUri? string - The URI of this About's API Description object. Available since 2.2.

uri? string - The URI of this About object.

userUri? string - The URI of this About's User object. Available since 2.2.

solace.semp: AboutResponse

Fields

data? About -

links? AboutLinks -

meta SempMeta -

solace.semp: AboutUser

Fields

globalAccessLevel? "admin"|"none"|"read-only"|"read-write" - The global access level of the User. The minimum access scope/level required to retrieve this attribute is "global/none". The allowed values and their meaning are: <pre> "admin" - Full administrative access. "none" - No access. "read-only" - Read only access. "read-write" - Read and write access. </pre>

sessionActive? boolean - Indicates whether a session is active for this request. The minimum access scope/level required to retrieve this attribute is "global/none". Available since 2.24.

sessionCreateTime? Signed32 - The timestamp of when the session was created. The minimum access scope/level required to retrieve this attribute is "global/none". This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.

sessionCurrentTime? Signed32 - The current server timestamp. This is provided as a reference point for the other timestamps provided. The minimum access scope/level required to retrieve this attribute is "global/none". This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.

sessionHardExpiryTime? Signed32 - The hard expiry time for the session. After this time the session will be invalid, regardless of activity. The minimum access scope/level required to retrieve this attribute is "global/none". This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.

sessionId? string - An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users. The minimum access scope/level required to retrieve this attribute is "global/none". This attribute may not be returned in a GET. Available since 2.21.

sessionIdleExpiryTime? Signed32 - The session idle expiry time. After this time the session will be invalid if there has been no activity. The minimum access scope/level required to retrieve this attribute is "global/none". This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.

username? string - The username of the User. The minimum access scope/level required to retrieve this attribute is "global/none". Available since 2.21.

solace.semp: AboutUserLinks

Fields

msgVpnsUri? string - The URI of this User's collection of User Message VPN objects.

uri? string - The URI of this User object.

solace.semp: AboutUserMsgVpn

Fields

accessLevel? "none"|"read-only"|"read-write" - The Message VPN access level of the User. The minimum access scope/level required to retrieve this attribute is "global/none". The allowed values and their meaning are: <pre> "none" - No access. "read-only" - Read only access. "read-write" - Read and write access. </pre>

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "global/none".

solace.semp: AboutUserMsgVpnLinks

Fields

uri? string - The URI of this User Message VPN object.

solace.semp: AboutUserMsgVpnResponse

Fields

data? AboutUserMsgVpn -

links? AboutUserMsgVpnLinks -

meta SempMeta -

solace.semp: AboutUserMsgVpnsResponse

Fields

data? AboutUserMsgVpn[] -

links? AboutUserMsgVpnLinks[] -

meta SempMeta -

solace.semp: AboutUserResponse

Fields

data? AboutUser -

links? AboutUserLinks -

meta SempMeta -

solace.semp: Broker

Fields

authBruteForceProtectionEnabled? boolean - Enable or disable protection against brute force password guessing attacks on local management accounts. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.40.

authClientCertRevocationCheckMode? "none"|"ocsp"|"crl"|"ocsp-crl" - The client certificate revocation checking mode used when a client authenticates with a client certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - Do not perform any certificate revocation checking. "ocsp" - Use the Online Certificate Status Protocol (OCSP) for certificate revocation checking. "crl" - Use Certificate Revocation Lists (CRL) for certificate revocation checking. "ocsp-crl" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL. </pre>

authRequiredAccessLevelGatherDiagnostics? "global-read-only"|"global-admin" - The access level required to generate encrypted gather-diagnostics output, which can only be decrypted by Solace support. global/admin is always required to generate unencrypted gather-diagnostics output. Gather-diagnostics output may contain sensitive information. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "global-read-only". The allowed values and their meaning are: <pre> "global-read-only" - Generating encrypted gather-diagnostics output requires global/read-only. "global-admin" - Generating encrypted gather-diagnostics output requires global/admin. </pre> Available since 2.48.

configSyncAuthenticationClientCertMaxChainDepth? int - The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 3. Deprecated since 2.48. Client certificate authentication is deprecated for config-sync.

configSyncAuthenticationClientCertValidateDateEnabled? boolean - Enable or disable validation of the "Not Before" and "Not After" validity dates in the authentication certificate(s). The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Deprecated since 2.48. Client certificate authentication is deprecated for config-sync.

configSyncClientProfileTcpInitialCongestionWindow? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 2. Deprecated since 2.48. The value is now ignored.

configSyncClientProfileTcpKeepaliveCount? int - The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 5. Available since 2.22.

configSyncClientProfileTcpKeepaliveIdle? int - The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 3. Available since 2.22.

configSyncClientProfileTcpKeepaliveInterval? int - The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 1. Available since 2.22.

configSyncClientProfileTcpMaxWindow? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 256. Deprecated since 2.48. The value is now ignored.

configSyncClientProfileTcpMss? int - The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 1460. Available since 2.22.

configSyncEnabled? boolean - Enable or disable configuration synchronization for High Availability or Disaster Recovery. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is false. Available since 2.22.

configSyncSynchronizeUsernameEnabled? boolean - Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.22.

configSyncTlsEnabled? boolean - Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is false. Available since 2.22.

guaranteedMsgingDefragmentationScheduleDayList? string - The days of the week to schedule defragmentation runs, specified as "daily" or as a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri, or "Sat", with no spaces, and in sorted order from Sunday to Saturday. Please note "Sun,Mon,Tue,Wed,Thu,Fri,Sat" is not allowed, use "daily" instead. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "daily". Available since 2.25.

guaranteedMsgingDefragmentationScheduleEnabled? boolean - Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.25.

guaranteedMsgingDefragmentationScheduleTimeList? string - The times of the day to schedule defragmentation runs, specified as "hourly" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "0:00". Available since 2.25.

guaranteedMsgingDefragmentationThresholdEnabled? boolean - Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.25.

guaranteedMsgingDefragmentationThresholdFragmentationPercentage? int - Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 50. Available since 2.25.

guaranteedMsgingDefragmentationThresholdMinInterval? int - Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 15. Available since 2.25.

guaranteedMsgingDefragmentationThresholdUsagePercentage? int - Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 50. Available since 2.25.

guaranteedMsgingEnabled? boolean - Enable or disable Guaranteed Messaging. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is false. Available since 2.18.

guaranteedMsgingEventCacheUsageThreshold? BrokerGuaranteedMsgingEventCacheUsageThreshold - The thresholds for the cache usage event at system level, relative to guaranteedMsgingMaxCacheUsage. Available since 2.18.

guaranteedMsgingEventDeliveredUnackedThreshold? BrokerGuaranteedMsgingEventDeliveredUnackedThreshold - The thresholds for the number of delivered but unacknowledged messages event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventDiskUsageThreshold? BrokerGuaranteedMsgingEventDiskUsageThreshold - The thresholds for the active disk partition usage event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventEgressFlowCountThreshold? BrokerGuaranteedMsgingEventEgressFlowCountThreshold - The thresholds for the transmit flow count event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventEndpointCountThreshold? BrokerGuaranteedMsgingEventEndpointCountThreshold - The thresholds for the endpoints count event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventIngressFlowCountThreshold? BrokerGuaranteedMsgingEventIngressFlowCountThreshold - The thresholds for the receive flow count event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventMsgCountThreshold? BrokerGuaranteedMsgingEventMsgCountThreshold - The thresholds for the spool message count event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventMsgSpoolFileCountThreshold? BrokerGuaranteedMsgingEventMsgSpoolFileCountThreshold - The thresholds for the spool file count event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventMsgSpoolUsageThreshold? BrokerGuaranteedMsgingEventMsgSpoolUsageThreshold - The thresholds for the spool usage event at system level, relative to maxSpoolUsage. Available since 2.18.

guaranteedMsgingEventTransactedSessionCountThreshold? BrokerGuaranteedMsgingEventTransactedSessionCountThreshold - The thresholds for the transacted sessions event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventTransactedSessionResourceCountThreshold? BrokerGuaranteedMsgingEventTransactedSessionResourceCountThreshold - The thresholds for the transacted session resources at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingEventTransactionCountThreshold? BrokerGuaranteedMsgingEventTransactionCountThreshold - The thresholds for the transactions event at system level, relative to the maximum system limit. Available since 2.18.

guaranteedMsgingMaxCacheUsage? Signed32 - Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 10. Available since 2.18.

guaranteedMsgingMaxMsgSpoolUsage? int - The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1500. Available since 2.18.

guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout? int - The maximum time, in milliseconds, that can be tolerated for remote acknowledgment of synchronization messages before which the remote system will be considered out of sync. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 10000. Available since 2.18.

guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout? int - The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 10000. Available since 2.18.

guaranteedMsgingTransactionReplicationCompatibilityMode? "legacy"|"transacted" - The replication compatibility mode for the broker. The default value is "legacy". The allowed values and their meaning are:"legacy" - All transactions originated by clients are replicated to the standby site without using transactions."transacted" - All transactions originated by clients are replicated to the standby site using transactions. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "legacy". The allowed values and their meaning are: <pre> "legacy" - All transactions originated by clients are replicated to the standby site without using transactions. "transacted" - All transactions originated by clients are replicated to the standby site using transactions. </pre> Available since 2.18.

oauthProfileDefault? string - The default OAuth profile for OAuth authenticated SEMP requests. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Available since 2.24.

serviceAmqpEnabled? boolean - Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceAmqpTlsListenPort? int - TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0. Available since 2.17.

serviceEventConnectionCountThreshold? BrokerServiceEventConnectionCountThreshold - The thresholds for the connection count event. Available since 2.17.

serviceHealthCheckEnabled? boolean - Enable or disable the plain-text health-check service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceHealthCheckListenPort? int - The port number for the plain-text health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceHealthCheckEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 5550. Available since 2.17.

serviceHealthCheckTlsEnabled? boolean - Enable or disable the TLS health-check service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.34.

serviceHealthCheckTlsListenPort? int - The port number for the TLS health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceHealthCheckTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0. Available since 2.34.

serviceMateLinkEnabled? boolean - Enable or disable the mate-link service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Available since 2.17.

serviceMateLinkListenPort? int - The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMateLinkEnabled will be temporarily set to false to apply the change. The default value is 8741. Available since 2.17.

serviceMqttEnabled? boolean - Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceMsgBackboneEnabled? boolean - Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Available since 2.17.

serviceRedundancyEnabled? boolean - Enable or disable the redundancy service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Available since 2.17.

serviceRedundancyFirstListenPort? int - The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceRedundancyEnabled will be temporarily set to false to apply the change. The default value is 8300. Available since 2.17.

serviceRestEventOutgoingConnectionCountThreshold? BrokerServiceRestEventOutgoingConnectionCountThreshold - The thresholds for the REST outgoing connection count event. Available since 2.17.

serviceRestIncomingEnabled? boolean - Enable or disable the REST service incoming connections on the broker. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceRestOutgoingEnabled? boolean - Enable or disable the REST service outgoing connections on the broker. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceSempCorsAllowAnyHostEnabled? boolean - Enable or disable cross origin resource requests for the SEMP service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.24.

serviceSempLegacyTimeoutEnabled? boolean - Enable or disable extended SEMP timeouts for paged responses. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.18.

serviceSempPlainTextEnabled? boolean - Enable or disable plain-text SEMP service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.17.

serviceSempPlainTextListenPort? int - The TCP port for plain-text SEMP client connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute cannot be cannot be changed while serviceSempPlainTextEnabled are set to true. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80. Available since 2.17.

serviceSempSessionIdleTimeout? Signed32 - The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 15. Available since 2.21.

serviceSempSessionMaxLifetime? Signed32 - The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 43200. Available since 2.21.

serviceSempTlsEnabled? boolean - Enable or disable TLS SEMP service. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.17.

serviceSempTlsListenPort? int - The TCP port for TLS SEMP client connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute cannot be cannot be changed while serviceSempTlsEnabled are set to true. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1943. Available since 2.17.

serviceSmfCompressionListenPort? int - TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is 55003. Available since 2.17.

serviceSmfEnabled? boolean - Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Available since 2.17.

serviceSmfEventConnectionCountThreshold? BrokerServiceSmfEventConnectionCountThreshold - The thresholds for the SMF connection count event. Available since 2.17.

serviceSmfPlainTextListenPort? int - TCP port number that SMF clients can use to connect to the broker using raw TCP. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is 55555. Available since 2.17.

serviceSmfRoutingControlListenPort? int - TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is 55556. Available since 2.17.

serviceSmfTlsListenPort? int - TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is 55443. Available since 2.17.

serviceTlsEventConnectionCountThreshold? BrokerServiceTlsEventConnectionCountThreshold - The thresholds for the incoming and outgoing TLS connection count event of the broker. Available since 2.17.

serviceWebTransportEnabled? boolean - Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.17.

serviceWebTransportPlainTextListenPort? int - The TCP port for plain-text WEB client connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 8008. Available since 2.17.

serviceWebTransportTlsListenPort? int - The TCP port for TLS WEB client connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1443. Available since 2.17.

serviceWebTransportWebUrlSuffix? string - Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. The default value is "". Available since 2.17.

tlsBlockVersion11Enabled? boolean - Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

tlsCipherSuiteManagementList? string - The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP) when using TLS 1.2 and lower. The value "default" implies all supported suites ordered from most secure to least secure. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "default".

tlsCipherSuiteMsgBackboneList? string - The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub) when using TLS 1.2 and lower. The value "default" implies all supported suites ordered from most secure to least secure. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "default".

tlsCipherSuiteSecureShellList? string - The colon-separated list of cipher suites used for secure shell connections (e.g. SSH, SFTP, SCP). The value "default" implies all supported suites ordered from most secure to least secure. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "default".

tlsCrimeExploitProtectionEnabled? boolean - Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

tlsServerCertContent? string - The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "".

tlsServerCertPassword? string - The password for the server certificate used for TLS connections. The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "".

tlsStandardDomainCertificateAuthoritiesEnabled? boolean - Enable or disable the standard domain certificate authority list. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is true. Available since 2.19.

tlsTicketLifetime? Signed32 - The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". The default value is 86400. Deprecated since 2.45. This attribute had been deprecated. TLS session tickets are no longer supported.

webManagerAllowUnencryptedWizardsEnabled? boolean - Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.28.

webManagerCustomization? string - Reserved for internal use by Solace. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Available since 2.25.

webManagerRedirectHttpEnabled? boolean - Enable or disable redirection of HTTP requests for the broker manager to HTTPS. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.24.

webManagerRedirectHttpOverrideTlsPort? Signed32 - The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0. Available since 2.24.

solace.semp: BrokerGuaranteedMsgingEventCacheUsageThreshold

The thresholds for the cache usage event at system level, relative to guaranteedMsgingMaxCacheUsage. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerGuaranteedMsgingEventDeliveredUnackedThreshold

The thresholds for the number of delivered but unacknowledged messages event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

solace.semp: BrokerGuaranteedMsgingEventDiskUsageThreshold

The thresholds for the active disk partition usage event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

solace.semp: BrokerGuaranteedMsgingEventEgressFlowCountThreshold

The thresholds for the transmit flow count event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerGuaranteedMsgingEventEndpointCountThreshold

The thresholds for the endpoints count event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerGuaranteedMsgingEventIngressFlowCountThreshold

The thresholds for the receive flow count event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerGuaranteedMsgingEventMsgCountThreshold

The thresholds for the spool message count event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

solace.semp: BrokerGuaranteedMsgingEventMsgSpoolFileCountThreshold

The thresholds for the spool file count event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

solace.semp: BrokerGuaranteedMsgingEventMsgSpoolUsageThreshold

The thresholds for the spool usage event at system level, relative to maxSpoolUsage. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerGuaranteedMsgingEventTransactedSessionCountThreshold

The thresholds for the transacted sessions event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is to have no clearValue.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is to have no setValue.

solace.semp: BrokerGuaranteedMsgingEventTransactedSessionResourceCountThreshold

The thresholds for the transacted session resources at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

solace.semp: BrokerGuaranteedMsgingEventTransactionCountThreshold

The thresholds for the transactions event at system level, relative to the maximum system limit. Available since 2.18.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerLinks

Fields

aboutUri? string - The URI of this Broker's About object.

certAuthoritiesUri? string - The URI of this Broker's collection of Certificate Authority objects. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.

clientCertAuthoritiesUri? string - The URI of this Broker's collection of Client Certificate Authority objects. Available since 2.19.

dmrClustersUri? string - The URI of this Broker's collection of Cluster objects. Available since 2.11.

domainCertAuthoritiesUri? string - The URI of this Broker's collection of Domain Certificate Authority objects. Available since 2.19.

msgVpnsUri? string - The URI of this Broker's collection of Message VPN objects. Available since 2.0.

oauthProfilesUri? string - The URI of this Broker's collection of OAuth Profile objects. Available since 2.24.

proxiesUri? string - The URI of this Broker's collection of Proxy objects. Available since 2.41.

systemInformationUri? string - The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api.

uri? string - The URI of this Broker object.

virtualHostnamesUri? string - The URI of this Broker's collection of Virtual Hostname objects. Available since 2.17.

solace.semp: BrokerResponse

Fields

data? Broker -

links? BrokerLinks -

meta SempMeta -

solace.semp: BrokerServiceEventConnectionCountThreshold

The thresholds for the connection count event. Available since 2.17.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerServiceRestEventOutgoingConnectionCountThreshold

The thresholds for the REST outgoing connection count event. Available since 2.17.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerServiceSmfEventConnectionCountThreshold

The thresholds for the SMF connection count event. Available since 2.17.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: BrokerServiceTlsEventConnectionCountThreshold

The thresholds for the incoming and outgoing TLS connection count event of the broker. Available since 2.17.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: CertAuthoritiesResponse

Fields

data? CertAuthority[] -

links? CertAuthorityLinks[] -

meta SempMeta -

solace.semp: CertAuthority

Fields

certAuthorityName? string - The name of the Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.

certContent? string - The PEM formatted content for the trusted root certificate of a Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

crlDayList? string - The scheduled CRL refresh day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "daily". Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

crlTimeList? string - The scheduled CRL refresh time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times must be in sorted order from 0:00 to 23:59. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "3:00". Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

crlUrl? string - The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. IPv6 addresses must be enclosed in square-brackets. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as revocationCheckEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

ocspNonResponderCertEnabled? boolean - Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

ocspOverrideUrl? string - The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

ocspTimeout? int - The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 5. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

revocationCheckEnabled? boolean - Enable or disable Certificate Authority revocation checking. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.

solace.semp: CertAuthorityLinks

Fields

ocspTlsTrustedCommonNamesUri? string - The URI of this Certificate Authority's collection of OCSP Responder Trusted Common Name objects. Deprecated since 2.19. Replaced by clientCertAuthorities.

uri? string - The URI of this Certificate Authority object.

solace.semp: CertAuthorityOcspTlsTrustedCommonName

Fields

certAuthorityName? string - The name of the Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.19. Replaced by clientCertAuthorities.

ocspTlsTrustedCommonName? string - The expected Trusted Common Name of the OCSP responder remote certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.19. Replaced by clientCertAuthorities.

solace.semp: CertAuthorityOcspTlsTrustedCommonNameLinks

Fields

uri? string - The URI of this OCSP Responder Trusted Common Name object.

solace.semp: CertAuthorityOcspTlsTrustedCommonNameResponse

Fields

data? CertAuthorityOcspTlsTrustedCommonName -

links? CertAuthorityOcspTlsTrustedCommonNameLinks -

meta SempMeta -

solace.semp: CertAuthorityOcspTlsTrustedCommonNamesResponse

Fields

data? CertAuthorityOcspTlsTrustedCommonName[] -

links? CertAuthorityOcspTlsTrustedCommonNameLinks[] -

meta SempMeta -

solace.semp: CertAuthorityResponse

Fields

data? CertAuthority -

links? CertAuthorityLinks -

meta SempMeta -

solace.semp: ClientCertAuthoritiesResponse

Fields

data? ClientCertAuthority[] -

links? ClientCertAuthorityLinks[] -

meta SempMeta -

solace.semp: ClientCertAuthority

Fields

certAuthorityName? string - The name of the Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only".

certContent? string - The PEM formatted content for the trusted root certificate of a client Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

crlDayList? string - The scheduled CRL refresh day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("crlTimeList" must also be configured to the empty-string). The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "daily".

crlTimeList? string - The scheduled CRL refresh time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("crlDayList" must also be configured to the empty-string). The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "3:00".

crlUrl? string - The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. IPv6 addresses must be enclosed in square-brackets. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as revocationCheckEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

ocspNonResponderCertEnabled? boolean - Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

ocspOverrideUrl? string - The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

ocspTimeout? int - The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 5.

revocationCheckEnabled? boolean - Enable or disable Certificate Authority revocation checking. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

solace.semp: ClientCertAuthorityLinks

Fields

ocspTlsTrustedCommonNamesUri? string - The URI of this Client Certificate Authority's collection of OCSP Responder Trusted Common Name objects.

uri? string - The URI of this Client Certificate Authority object.

solace.semp: ClientCertAuthorityOcspTlsTrustedCommonName

Fields

certAuthorityName? string - The name of the Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only".

ocspTlsTrustedCommonName? string - The expected Trusted Common Name of the OCSP responder remote certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: ClientCertAuthorityOcspTlsTrustedCommonNameLinks

Fields

uri? string - The URI of this OCSP Responder Trusted Common Name object.

solace.semp: ClientCertAuthorityOcspTlsTrustedCommonNameResponse

Fields

data? ClientCertAuthorityOcspTlsTrustedCommonName -

links? ClientCertAuthorityOcspTlsTrustedCommonNameLinks -

meta SempMeta -

solace.semp: ClientCertAuthorityOcspTlsTrustedCommonNamesResponse

Fields

data? ClientCertAuthorityOcspTlsTrustedCommonName[] -

links? ClientCertAuthorityOcspTlsTrustedCommonNameLinks[] -

meta SempMeta -

solace.semp: ClientCertAuthorityResponse

Fields

data? ClientCertAuthority -

links? ClientCertAuthorityLinks -

meta SempMeta -

solace.semp: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth CredentialsConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

solace.semp: CreateCertAuthorityOcspTlsTrustedCommonNameQueries

Represents the Queries record for the operation: createCertAuthorityOcspTlsTrustedCommonName

Fields

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

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.

solace.semp: CreateCertAuthorityQueries

Represents the Queries record for the operation: createCertAuthority

Fields

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

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.

solace.semp: CreateClientCertAuthorityOcspTlsTrustedCommonNameQueries

Represents the Queries record for the operation: createClientCertAuthorityOcspTlsTrustedCommonName

Fields

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

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.

solace.semp: CreateClientCertAuthorityQueries

Represents the Queries record for the operation: createClientCertAuthority

Fields

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

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.

solace.semp: CreateDmrClusterCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: createDmrClusterCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: CreateDmrClusterCertMatchingRuleConditionQueries

Represents the Queries record for the operation: createDmrClusterCertMatchingRuleCondition

Fields

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

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.

solace.semp: CreateDmrClusterCertMatchingRuleQueries

Represents the Queries record for the operation: createDmrClusterCertMatchingRule

Fields

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

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.

solace.semp: CreateDmrClusterLinkAttributeQueries

Represents the Queries record for the operation: createDmrClusterLinkAttribute

Fields

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

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.

solace.semp: CreateDmrClusterLinkQueries

Represents the Queries record for the operation: createDmrClusterLink

Fields

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

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.

solace.semp: CreateDmrClusterLinkRemoteAddressQueries

Represents the Queries record for the operation: createDmrClusterLinkRemoteAddress

Fields

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

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.

solace.semp: CreateDmrClusterLinkTlsTrustedCommonNameQueries

Represents the Queries record for the operation: createDmrClusterLinkTlsTrustedCommonName

Fields

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

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.

solace.semp: CreateDmrClusterQueries

Represents the Queries record for the operation: createDmrCluster

Fields

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

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.

solace.semp: CreateDomainCertAuthorityQueries

Represents the Queries record for the operation: createDomainCertAuthority

Fields

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

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.

solace.semp: CreateMsgVpnAclProfileClientConnectExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfileClientConnectException

Fields

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

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.

solace.semp: CreateMsgVpnAclProfilePublishExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfilePublishException

Fields

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

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.

solace.semp: CreateMsgVpnAclProfilePublishTopicExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfilePublishTopicException

Fields

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

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.

solace.semp: CreateMsgVpnAclProfileQueries

Represents the Queries record for the operation: createMsgVpnAclProfile

Fields

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

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.

solace.semp: CreateMsgVpnAclProfileSubscribeExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfileSubscribeException

Fields

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

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.

solace.semp: CreateMsgVpnAclProfileSubscribeShareNameExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfileSubscribeShareNameException

Fields

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

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.

solace.semp: CreateMsgVpnAclProfileSubscribeTopicExceptionQueries

Represents the Queries record for the operation: createMsgVpnAclProfileSubscribeTopicException

Fields

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

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.

solace.semp: CreateMsgVpnAuthenticationKerberosRealmQueries

Represents the Queries record for the operation: createMsgVpnAuthenticationKerberosRealm

Fields

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

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.

solace.semp: CreateMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries

Represents the Queries record for the operation: createMsgVpnAuthenticationOauthProfileClientRequiredClaim

Fields

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

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.

solace.semp: CreateMsgVpnAuthenticationOauthProfileQueries

Represents the Queries record for the operation: createMsgVpnAuthenticationOauthProfile

Fields

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

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.

solace.semp: CreateMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries

Represents the Queries record for the operation: createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Fields

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

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.

solace.semp: CreateMsgVpnAuthenticationOauthProviderQueries

Represents the Queries record for the operation: createMsgVpnAuthenticationOauthProvider

Fields

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

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.

solace.semp: CreateMsgVpnAuthorizationGroupQueries

Represents the Queries record for the operation: createMsgVpnAuthorizationGroup

Fields

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

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.

solace.semp: CreateMsgVpnBridgeQueries

Represents the Queries record for the operation: createMsgVpnBridge

Fields

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

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.

solace.semp: CreateMsgVpnBridgeRemoteMsgVpnQueries

Represents the Queries record for the operation: createMsgVpnBridgeRemoteMsgVpn

Fields

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

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.

solace.semp: CreateMsgVpnBridgeRemoteSubscriptionQueries

Represents the Queries record for the operation: createMsgVpnBridgeRemoteSubscription

Fields

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

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.

solace.semp: CreateMsgVpnBridgeTlsTrustedCommonNameQueries

Represents the Queries record for the operation: createMsgVpnBridgeTlsTrustedCommonName

Fields

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

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.

solace.semp: CreateMsgVpnCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: createMsgVpnCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: CreateMsgVpnCertMatchingRuleConditionQueries

Represents the Queries record for the operation: createMsgVpnCertMatchingRuleCondition

Fields

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

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.

solace.semp: CreateMsgVpnCertMatchingRuleQueries

Represents the Queries record for the operation: createMsgVpnCertMatchingRule

Fields

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

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.

solace.semp: CreateMsgVpnClientProfileQueries

Represents the Queries record for the operation: createMsgVpnClientProfile

Fields

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

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.

solace.semp: CreateMsgVpnClientUsernameAttributeQueries

Represents the Queries record for the operation: createMsgVpnClientUsernameAttribute

Fields

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

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.

solace.semp: CreateMsgVpnClientUsernameQueries

Represents the Queries record for the operation: createMsgVpnClientUsername

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries

Represents the Queries record for the operation: createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries

Represents the Queries record for the operation: createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheClusterInstanceQueries

Represents the Queries record for the operation: createMsgVpnDistributedCacheClusterInstance

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheClusterQueries

Represents the Queries record for the operation: createMsgVpnDistributedCacheCluster

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheClusterTopicQueries

Represents the Queries record for the operation: createMsgVpnDistributedCacheClusterTopic

Fields

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

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.

solace.semp: CreateMsgVpnDistributedCacheQueries

Represents the Queries record for the operation: createMsgVpnDistributedCache

Fields

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

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.

solace.semp: CreateMsgVpnDmrBridgeQueries

Represents the Queries record for the operation: createMsgVpnDmrBridge

Fields

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

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.

solace.semp: CreateMsgVpnJndiConnectionFactoryQueries

Represents the Queries record for the operation: createMsgVpnJndiConnectionFactory

Fields

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

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.

solace.semp: CreateMsgVpnJndiQueueQueries

Represents the Queries record for the operation: createMsgVpnJndiQueue

Fields

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

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.

solace.semp: CreateMsgVpnJndiTopicQueries

Represents the Queries record for the operation: createMsgVpnJndiTopic

Fields

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

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.

solace.semp: CreateMsgVpnKafkaReceiverQueries

Represents the Queries record for the operation: createMsgVpnKafkaReceiver

Fields

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

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.

solace.semp: CreateMsgVpnKafkaReceiverTopicBindingQueries

Represents the Queries record for the operation: createMsgVpnKafkaReceiverTopicBinding

Fields

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

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.

solace.semp: CreateMsgVpnKafkaSenderQueries

Represents the Queries record for the operation: createMsgVpnKafkaSender

Fields

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

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.

solace.semp: CreateMsgVpnKafkaSenderQueueBindingQueries

Represents the Queries record for the operation: createMsgVpnKafkaSenderQueueBinding

Fields

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

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.

solace.semp: CreateMsgVpnMqttRetainCacheQueries

Represents the Queries record for the operation: createMsgVpnMqttRetainCache

Fields

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

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.

solace.semp: CreateMsgVpnMqttSessionQueries

Represents the Queries record for the operation: createMsgVpnMqttSession

Fields

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

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.

solace.semp: CreateMsgVpnMqttSessionSubscriptionQueries

Represents the Queries record for the operation: createMsgVpnMqttSessionSubscription

Fields

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

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.

solace.semp: CreateMsgVpnProxyQueries

Represents the Queries record for the operation: createMsgVpnProxy

Fields

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

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.

solace.semp: CreateMsgVpnQueries

Represents the Queries record for the operation: createMsgVpn

Fields

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

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.

solace.semp: CreateMsgVpnQueueQueries

Represents the Queries record for the operation: createMsgVpnQueue

Fields

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

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.

solace.semp: CreateMsgVpnQueueSubscriptionQueries

Represents the Queries record for the operation: createMsgVpnQueueSubscription

Fields

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

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.

solace.semp: CreateMsgVpnQueueTemplateQueries

Represents the Queries record for the operation: createMsgVpnQueueTemplate

Fields

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

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.

solace.semp: CreateMsgVpnReplayLogQueries

Represents the Queries record for the operation: createMsgVpnReplayLog

Fields

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

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.

solace.semp: CreateMsgVpnReplayLogTopicFilterSubscriptionQueries

Represents the Queries record for the operation: createMsgVpnReplayLogTopicFilterSubscription

Fields

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

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.

solace.semp: CreateMsgVpnReplicatedTopicQueries

Represents the Queries record for the operation: createMsgVpnReplicatedTopic

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPoint

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointQueueBindingQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointQueueBinding

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointQueueBindingRequestHeader

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointRestConsumerQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointRestConsumer

Fields

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

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.

solace.semp: CreateMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries

Represents the Queries record for the operation: createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

Fields

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

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.

solace.semp: CreateMsgVpnSequencedTopicQueries

Represents the Queries record for the operation: createMsgVpnSequencedTopic

Fields

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

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.

solace.semp: CreateMsgVpnTelemetryProfileQueries

Represents the Queries record for the operation: createMsgVpnTelemetryProfile

Fields

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

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.

solace.semp: CreateMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries

Represents the Queries record for the operation: createMsgVpnTelemetryProfileReceiverAclConnectException

Fields

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

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.

solace.semp: CreateMsgVpnTelemetryProfileTraceFilterQueries

Represents the Queries record for the operation: createMsgVpnTelemetryProfileTraceFilter

Fields

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

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.

solace.semp: CreateMsgVpnTelemetryProfileTraceFilterSubscriptionQueries

Represents the Queries record for the operation: createMsgVpnTelemetryProfileTraceFilterSubscription

Fields

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

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.

solace.semp: CreateMsgVpnTopicEndpointQueries

Represents the Queries record for the operation: createMsgVpnTopicEndpoint

Fields

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

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.

solace.semp: CreateMsgVpnTopicEndpointTemplateQueries

Represents the Queries record for the operation: createMsgVpnTopicEndpointTemplate

Fields

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

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.

solace.semp: CreateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: createOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Fields

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

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.

solace.semp: CreateOauthProfileAccessLevelGroupQueries

Represents the Queries record for the operation: createOauthProfileAccessLevelGroup

Fields

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

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.

solace.semp: CreateOauthProfileClientAllowedHostQueries

Represents the Queries record for the operation: createOauthProfileClientAllowedHost

Fields

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

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.

solace.semp: CreateOauthProfileClientAuthorizationParameterQueries

Represents the Queries record for the operation: createOauthProfileClientAuthorizationParameter

Fields

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

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.

solace.semp: CreateOauthProfileClientRequiredClaimQueries

Represents the Queries record for the operation: createOauthProfileClientRequiredClaim

Fields

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

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.

solace.semp: CreateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: createOauthProfileDefaultMsgVpnAccessLevelException

Fields

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

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.

solace.semp: CreateOauthProfileQueries

Represents the Queries record for the operation: createOauthProfile

Fields

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

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.

solace.semp: CreateOauthProfileResourceServerRequiredClaimQueries

Represents the Queries record for the operation: createOauthProfileResourceServerRequiredClaim

Fields

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

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.

solace.semp: CreateProxyQueries

Represents the Queries record for the operation: createProxy

Fields

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

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.

solace.semp: CreateVirtualHostnameQueries

Represents the Queries record for the operation: createVirtualHostname

Fields

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

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.

solace.semp: DmrCluster

Fields

authenticationBasicEnabled? boolean - Enable or disable basic authentication for Cluster Links. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

authenticationBasicPassword? string - The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationBasicType? "internal"|"none" - The type of basic authentication to use for Cluster Links. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "internal". The allowed values and their meaning are: <pre> "internal" - Use locally configured password. "none" - No authentication. </pre>

authenticationClientCertContent? string - The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

authenticationClientCertEnabled? boolean - Enable or disable client certificate authentication for Cluster Links. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

authenticationClientCertPassword? string - The password for the client certificate. The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

directOnlyEnabled? boolean - Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only". The default value is false.

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

enabled? boolean - Enable or disable the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

nodeName? string - The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group. The minimum access scope/level required to retrieve this attribute is "global/read-only".

tlsServerCertEnforceTrustedCommonNameEnabled? boolean - Enable or disable the enforcing of the common name provided by the remote broker against the list of trusted common names configured for the Link. If enabled, the certificate's common name must match one of the trusted common names for the Link to be accepted. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

tlsServerCertMaxChainDepth? int - The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 3.

tlsServerCertValidateDateEnabled? boolean - Enable or disable the validation of the "Not Before" and "Not After" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

tlsServerCertValidateNameEnabled? boolean - Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true. Available since 2.18.

solace.semp: DmrClusterCertMatchingRule

Fields

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

enabled? boolean - Enable or disable a certificate matching rule. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: DmrClusterCertMatchingRuleAttributeFilter

Fields

attributeName? string - Link Attribute to be tested. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

attributeValue? string - Expected attribute value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

filterName? string - The name of the filter. The minimum access scope/level required to retrieve this attribute is "global/read-only".

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: DmrClusterCertMatchingRuleAttributeFilterLinks

Fields

uri? string - The URI of this Certificate Matching Rule Attribute Filter object.

solace.semp: DmrClusterCertMatchingRuleAttributeFilterResponse

Fields

data? DmrClusterCertMatchingRuleAttributeFilter -

links? DmrClusterCertMatchingRuleAttributeFilterLinks -

meta SempMeta -

solace.semp: DmrClusterCertMatchingRuleAttributeFiltersResponse

Fields

data? DmrClusterCertMatchingRuleAttributeFilter[] -

links? DmrClusterCertMatchingRuleAttributeFilterLinks[] -

meta SempMeta -

solace.semp: DmrClusterCertMatchingRuleCondition

Fields

attribute? string - Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The minimum access scope/level required to retrieve this attribute is "global/read-only". The default value is "".

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

expression? string - Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The minimum access scope/level required to retrieve this attribute is "global/read-only". The default value is "".

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "global/read-only".

'source? "certificate-thumbprint"|"common-name"|"common-name-last"|"subject-alternate-name-msupn"|"uid"|"uid-last"|"org-unit"|"org-unit-last"|"issuer"|"subject"|"serial-number"|"dns-name"|"ip-address" - Certificate field to be compared with the Attribute. The minimum access scope/level required to retrieve this attribute is "global/read-only". The allowed values and their meaning are: <pre> "certificate-thumbprint" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. "common-name" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. "common-name-last" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. "subject-alternate-name-msupn" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. "uid" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. "uid-last" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. "org-unit" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. "org-unit-last" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. "issuer" - The attribute is extracted from the certificate's Issuer DN. "subject" - The attribute is extracted from the certificate's Subject DN. "serial-number" - The attribute is extracted from the certificate's Serial Number. "dns-name" - The attribute is extracted from the certificate's Subject Alt Name DNS Name. "ip-address" - The attribute is extracted from the certificate's Subject Alt Name IP Address. </pre>

solace.semp: DmrClusterCertMatchingRuleConditionLinks

Fields

uri? string - The URI of this Certificate Matching Rule Condition object.

solace.semp: DmrClusterCertMatchingRuleConditionResponse

Fields

data? DmrClusterCertMatchingRuleCondition -

links? DmrClusterCertMatchingRuleConditionLinks -

meta SempMeta -

solace.semp: DmrClusterCertMatchingRuleConditionsResponse

Fields

data? DmrClusterCertMatchingRuleCondition[] -

links? DmrClusterCertMatchingRuleConditionLinks[] -

meta SempMeta -

solace.semp: DmrClusterCertMatchingRuleLinks

Fields

attributeFiltersUri? string - The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects.

conditionsUri? string - The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.

uri? string - The URI of this Certificate Matching Rule object.

solace.semp: DmrClusterCertMatchingRuleResponse

Fields

data? DmrClusterCertMatchingRule -

links? DmrClusterCertMatchingRuleLinks -

meta SempMeta -

solace.semp: DmrClusterCertMatchingRulesResponse

Fields

data? DmrClusterCertMatchingRule[] -

links? DmrClusterCertMatchingRuleLinks[] -

meta SempMeta -

solace.semp: DmrClusterLink

Fields

authenticationBasicPassword? string - The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationScheme? "basic"|"client-certificate" - The authentication scheme to be used by the Link which initiates connections to the remote node. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "basic". The allowed values and their meaning are: <pre> "basic" - Basic Authentication Scheme (via username and password). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). </pre>

clientProfileQueueControl1MaxDepth? Signed32 - The maximum depth of the "Control 1" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

clientProfileQueueControl1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Control 1" (C-1) priority queue, regardless of the clientProfileQueueControl1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

clientProfileQueueDirect1MaxDepth? Signed32 - The maximum depth of the "Direct 1" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

clientProfileQueueDirect1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 1" (D-1) priority queue, regardless of the clientProfileQueueDirect1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

clientProfileQueueDirect2MaxDepth? Signed32 - The maximum depth of the "Direct 2" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

clientProfileQueueDirect2MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 2" (D-2) priority queue, regardless of the clientProfileQueueDirect2MaxDepth value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

clientProfileQueueDirect3MaxDepth? Signed32 - The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

clientProfileQueueDirect3MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the clientProfileQueueDirect3MaxDepth value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

clientProfileQueueGuaranteed1MaxDepth? Signed32 - The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

clientProfileQueueGuaranteed1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the clientProfileQueueGuaranteed1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 255.

clientProfileTcpCongestionWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". The default value is 2. Deprecated since 2.48. The value is now ignored.

clientProfileTcpKeepaliveCount? int - The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 5.

clientProfileTcpKeepaliveIdleTime? int - The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 3.

clientProfileTcpKeepaliveInterval? int - The amount of time between TCP keepalive retransmissions when no acknowledgment is received, in seconds. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

clientProfileTcpMaxSegmentSize? int - The TCP maximum segment size, in bytes. Changes are applied to all existing connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1460.

clientProfileTcpMaxWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". The default value is 256. Deprecated since 2.48. The value is now ignored.

connectionRetryCount? int - The number of retry attempts to establish a connection before moving on to the next remote Message VPN. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0. Available since 2.41.

connectionRetryDelay? int - The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 3. Available since 2.41.

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

egressFlowWindowSize? int - The number of outstanding guaranteed messages that can be sent over the Link before acknowledgment is received by the sender. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 255.

enabled? boolean - Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

initiator? "lexical"|"local"|"remote" - The initiator of the Link's TCP connections. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "lexical". The allowed values and their meaning are: <pre> "lexical" - The "higher" node-name initiates. "local" - The local node initiates. "remote" - The remote node initiates. </pre>

queueDeadMsgQueue? string - The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "#DEAD_MSG_QUEUE".

queueEventSpoolUsageThreshold? DmrClusterLinkQueueEventSpoolUsageThreshold - The thresholds for the message spool usage event of the Queue, relative to queueMaxMsgSpoolUsage.

queueMaxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow for the Queue. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1000000.

queueMaxMsgSpoolUsage? int - The maximum message spool usage by the Queue (quota), in megabytes (MB). The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 800000.

queueMaxRedeliveryCount? int - The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

queueMaxTtl? int - The maximum time in seconds a message can stay in the Queue when queueRespectTtlEnabled is true. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the queueMaxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

queueRejectMsgToSenderOnDiscardBehavior? "never"|"when-queue-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "always". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-queue-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre>

queueRespectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the Queue. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false. Available since 2.49.

queueRespectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

remoteNodeName? string - The name of the node at the remote end of the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only".

span? "internal"|"external" - The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "external". The allowed values and their meaning are: <pre> "internal" - Link to same cluster. "external" - Link to other cluster. </pre>

transportCompressedEnabled? boolean - Enable or disable compression on the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

transportTlsEnabled? boolean - Enable or disable encryption (TLS) on the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

solace.semp: DmrClusterLinkAttribute

Fields

attributeName? string - The name of the Attribute. The minimum access scope/level required to retrieve this attribute is "global/read-only".

attributeValue? string - The value of the Attribute. The minimum access scope/level required to retrieve this attribute is "global/read-only".

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

remoteNodeName? string - The name of the node at the remote end of the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: DmrClusterLinkAttributeLinks

Fields

uri? string - The URI of this Link Attribute object.

solace.semp: DmrClusterLinkAttributeResponse

Fields

data? DmrClusterLinkAttribute -

links? DmrClusterLinkAttributeLinks -

meta SempMeta -

solace.semp: DmrClusterLinkAttributesResponse

Fields

data? DmrClusterLinkAttribute[] -

links? DmrClusterLinkAttributeLinks[] -

meta SempMeta -

solace.semp: DmrClusterLinkLinks

Fields

attributesUri? string - The URI of this Link's collection of Link Attribute objects. Available since 2.28.

remoteAddressesUri? string - The URI of this Link's collection of Remote Address objects.

tlsTrustedCommonNamesUri? string - The URI of this Link's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

uri? string - The URI of this Link object.

solace.semp: DmrClusterLinkQueueEventSpoolUsageThreshold

The thresholds for the message spool usage event of the Queue, relative to queueMaxMsgSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 2.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates via config-sync. The default is not applicable.

solace.semp: DmrClusterLinkRemoteAddress

Fields

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only".

remoteAddress? string - The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). The minimum access scope/level required to retrieve this attribute is "global/read-only".

remoteNodeName? string - The name of the node at the remote end of the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: DmrClusterLinkRemoteAddressesResponse

Fields

data? DmrClusterLinkRemoteAddress[] -

links? DmrClusterLinkRemoteAddressLinks[] -

meta SempMeta -

solace.semp: DmrClusterLinkRemoteAddressLinks

Fields

uri? string - The URI of this Remote Address object.

solace.semp: DmrClusterLinkRemoteAddressResponse

Fields

data? DmrClusterLinkRemoteAddress -

links? DmrClusterLinkRemoteAddressLinks -

meta SempMeta -

solace.semp: DmrClusterLinkResponse

Fields

data? DmrClusterLink -

links? DmrClusterLinkLinks -

meta SempMeta -

solace.semp: DmrClusterLinks

Fields

certMatchingRulesUri? string - The URI of this Cluster's collection of Certificate Matching Rule objects. Available since 2.28.

linksUri? string - The URI of this Cluster's collection of Link objects.

uri? string - The URI of this Cluster object.

solace.semp: DmrClusterLinksResponse

Fields

data? DmrClusterLink[] -

links? DmrClusterLinkLinks[] -

meta SempMeta -

solace.semp: DmrClusterLinkTlsTrustedCommonName

Fields

dmrClusterName? string - The name of the Cluster. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

remoteNodeName? string - The name of the node at the remote end of the Link. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

tlsTrustedCommonName? string - The expected trusted common name of the remote certificate. The minimum access scope/level required to retrieve this attribute is "global/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

solace.semp: DmrClusterLinkTlsTrustedCommonNameLinks

Fields

uri? string - The URI of this Trusted Common Name object.

solace.semp: DmrClusterLinkTlsTrustedCommonNameResponse

Fields

data? DmrClusterLinkTlsTrustedCommonName -

links? DmrClusterLinkTlsTrustedCommonNameLinks -

meta SempMeta -

solace.semp: DmrClusterLinkTlsTrustedCommonNamesResponse

Fields

data? DmrClusterLinkTlsTrustedCommonName[] -

links? DmrClusterLinkTlsTrustedCommonNameLinks[] -

meta SempMeta -

solace.semp: DmrClusterResponse

Fields

data? DmrCluster -

links? DmrClusterLinks -

meta SempMeta -

solace.semp: DmrClustersResponse

Fields

data? DmrCluster[] -

links? DmrClusterLinks[] -

meta SempMeta -

solace.semp: DomainCertAuthoritiesResponse

Fields

data? DomainCertAuthority[] -

links? DomainCertAuthorityLinks[] -

meta SempMeta -

solace.semp: DomainCertAuthority

Fields

certAuthorityName? string - The name of the Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only".

certContent? string - The PEM formatted content for the trusted root certificate of a domain Certificate Authority. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

solace.semp: DomainCertAuthorityLinks

Fields

uri? string - The URI of this Domain Certificate Authority object.

solace.semp: DomainCertAuthorityResponse

Fields

data? DomainCertAuthority -

links? DomainCertAuthorityLinks -

meta SempMeta -

solace.semp: GetAboutApiQueries

Represents the Queries record for the operation: getAboutApi

Fields

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

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.

solace.semp: GetAboutQueries

Represents the Queries record for the operation: getAbout

Fields

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

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.

solace.semp: GetAboutUserMsgVpnQueries

Represents the Queries record for the operation: getAboutUserMsgVpn

Fields

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

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.

solace.semp: GetAboutUserMsgVpnsQueries

Represents the Queries record for the operation: getAboutUserMsgVpns

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetAboutUserQueries

Represents the Queries record for the operation: getAboutUser

Fields

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

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.

solace.semp: GetBrokerQueries

Represents the Queries record for the operation: getBroker

Fields

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

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.

solace.semp: GetCertAuthoritiesQueries

Represents the Queries record for the operation: getCertAuthorities

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetCertAuthorityOcspTlsTrustedCommonNameQueries

Represents the Queries record for the operation: getCertAuthorityOcspTlsTrustedCommonName

Fields

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

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.

solace.semp: GetCertAuthorityOcspTlsTrustedCommonNamesQueries

Represents the Queries record for the operation: getCertAuthorityOcspTlsTrustedCommonNames

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetCertAuthorityQueries

Represents the Queries record for the operation: getCertAuthority

Fields

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

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.

solace.semp: GetClientCertAuthoritiesQueries

Represents the Queries record for the operation: getClientCertAuthorities

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetClientCertAuthorityOcspTlsTrustedCommonNameQueries

Represents the Queries record for the operation: getClientCertAuthorityOcspTlsTrustedCommonName

Fields

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

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.

solace.semp: GetClientCertAuthorityOcspTlsTrustedCommonNamesQueries

Represents the Queries record for the operation: getClientCertAuthorityOcspTlsTrustedCommonNames

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetClientCertAuthorityQueries

Represents the Queries record for the operation: getClientCertAuthority

Fields

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

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.

solace.semp: GetDmrClusterCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: GetDmrClusterCertMatchingRuleAttributeFiltersQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRuleAttributeFilters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterCertMatchingRuleConditionQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRuleCondition

Fields

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

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.

solace.semp: GetDmrClusterCertMatchingRuleConditionsQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRuleConditions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterCertMatchingRuleQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRule

Fields

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

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.

solace.semp: GetDmrClusterCertMatchingRulesQueries

Represents the Queries record for the operation: getDmrClusterCertMatchingRules

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterLinkAttributeQueries

Represents the Queries record for the operation: getDmrClusterLinkAttribute

Fields

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

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.

solace.semp: GetDmrClusterLinkAttributesQueries

Represents the Queries record for the operation: getDmrClusterLinkAttributes

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterLinkQueries

Represents the Queries record for the operation: getDmrClusterLink

Fields

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

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.

solace.semp: GetDmrClusterLinkRemoteAddressesQueries

Represents the Queries record for the operation: getDmrClusterLinkRemoteAddresses

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterLinkRemoteAddressQueries

Represents the Queries record for the operation: getDmrClusterLinkRemoteAddress

Fields

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

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.

solace.semp: GetDmrClusterLinksQueries

Represents the Queries record for the operation: getDmrClusterLinks

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterLinkTlsTrustedCommonNameQueries

Represents the Queries record for the operation: getDmrClusterLinkTlsTrustedCommonName

Fields

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

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.

solace.semp: GetDmrClusterLinkTlsTrustedCommonNamesQueries

Represents the Queries record for the operation: getDmrClusterLinkTlsTrustedCommonNames

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDmrClusterQueries

Represents the Queries record for the operation: getDmrCluster

Fields

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

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.

solace.semp: GetDmrClustersQueries

Represents the Queries record for the operation: getDmrClusters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDomainCertAuthoritiesQueries

Represents the Queries record for the operation: getDomainCertAuthorities

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetDomainCertAuthorityQueries

Represents the Queries record for the operation: getDomainCertAuthority

Fields

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

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.

solace.semp: GetMsgVpnAclProfileClientConnectExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfileClientConnectException

Fields

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

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.

solace.semp: GetMsgVpnAclProfileClientConnectExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfileClientConnectExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfilePublishExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfilePublishException

Fields

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

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.

solace.semp: GetMsgVpnAclProfilePublishExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfilePublishExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfilePublishTopicExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfilePublishTopicException

Fields

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

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.

solace.semp: GetMsgVpnAclProfilePublishTopicExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfilePublishTopicExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfileQueries

Represents the Queries record for the operation: getMsgVpnAclProfile

Fields

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

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.

solace.semp: GetMsgVpnAclProfilesQueries

Represents the Queries record for the operation: getMsgVpnAclProfiles

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfileSubscribeExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeException

Fields

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

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.

solace.semp: GetMsgVpnAclProfileSubscribeExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfileSubscribeShareNameExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeShareNameException

Fields

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

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.

solace.semp: GetMsgVpnAclProfileSubscribeShareNameExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeShareNameExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAclProfileSubscribeTopicExceptionQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeTopicException

Fields

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

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.

solace.semp: GetMsgVpnAclProfileSubscribeTopicExceptionsQueries

Represents the Queries record for the operation: getMsgVpnAclProfileSubscribeTopicExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthenticationKerberosRealmQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationKerberosRealm

Fields

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

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.

solace.semp: GetMsgVpnAuthenticationKerberosRealmsQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationKerberosRealms

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthenticationOauthProfileClientRequiredClaimQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfileClientRequiredClaim

Fields

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

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.

solace.semp: GetMsgVpnAuthenticationOauthProfileClientRequiredClaimsQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfileClientRequiredClaims

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthenticationOauthProfileQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfile

Fields

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

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.

solace.semp: GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Fields

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

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.

solace.semp: GetMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthenticationOauthProfilesQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProfiles

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthenticationOauthProviderQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProvider

Fields

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

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.

solace.semp: GetMsgVpnAuthenticationOauthProvidersQueries

Represents the Queries record for the operation: getMsgVpnAuthenticationOauthProviders

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnAuthorizationGroupQueries

Represents the Queries record for the operation: getMsgVpnAuthorizationGroup

Fields

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

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.

solace.semp: GetMsgVpnAuthorizationGroupsQueries

Represents the Queries record for the operation: getMsgVpnAuthorizationGroups

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnBridgeQueries

Represents the Queries record for the operation: getMsgVpnBridge

Fields

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

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.

solace.semp: GetMsgVpnBridgeRemoteMsgVpnQueries

Represents the Queries record for the operation: getMsgVpnBridgeRemoteMsgVpn

Fields

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

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.

solace.semp: GetMsgVpnBridgeRemoteMsgVpnsQueries

Represents the Queries record for the operation: getMsgVpnBridgeRemoteMsgVpns

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnBridgeRemoteSubscriptionQueries

Represents the Queries record for the operation: getMsgVpnBridgeRemoteSubscription

Fields

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

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.

solace.semp: GetMsgVpnBridgeRemoteSubscriptionsQueries

Represents the Queries record for the operation: getMsgVpnBridgeRemoteSubscriptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnBridgesQueries

Represents the Queries record for the operation: getMsgVpnBridges

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnBridgeTlsTrustedCommonNameQueries

Represents the Queries record for the operation: getMsgVpnBridgeTlsTrustedCommonName

Fields

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

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.

solace.semp: GetMsgVpnBridgeTlsTrustedCommonNamesQueries

Represents the Queries record for the operation: getMsgVpnBridgeTlsTrustedCommonNames

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: GetMsgVpnCertMatchingRuleAttributeFiltersQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRuleAttributeFilters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnCertMatchingRuleConditionQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRuleCondition

Fields

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

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.

solace.semp: GetMsgVpnCertMatchingRuleConditionsQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRuleConditions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnCertMatchingRuleQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRule

Fields

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

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.

solace.semp: GetMsgVpnCertMatchingRulesQueries

Represents the Queries record for the operation: getMsgVpnCertMatchingRules

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnClientProfileQueries

Represents the Queries record for the operation: getMsgVpnClientProfile

Fields

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

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.

solace.semp: GetMsgVpnClientProfilesQueries

Represents the Queries record for the operation: getMsgVpnClientProfiles

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnClientUsernameAttributeQueries

Represents the Queries record for the operation: getMsgVpnClientUsernameAttribute

Fields

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

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.

solace.semp: GetMsgVpnClientUsernameAttributesQueries

Represents the Queries record for the operation: getMsgVpnClientUsernameAttributes

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnClientUsernameQueries

Represents the Queries record for the operation: getMsgVpnClientUsername

Fields

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

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.

solace.semp: GetMsgVpnClientUsernamesQueries

Represents the Queries record for the operation: getMsgVpnClientUsernames

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Fields

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

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.

solace.semp: GetMsgVpnDistributedCacheClusterGlobalCachingHomeClustersQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Fields

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

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.

solace.semp: GetMsgVpnDistributedCacheClusterInstanceQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterInstance

Fields

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

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.

solace.semp: GetMsgVpnDistributedCacheClusterInstancesQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterInstances

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheClusterQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheCluster

Fields

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

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.

solace.semp: GetMsgVpnDistributedCacheClustersQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheClusterTopicQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterTopic

Fields

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

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.

solace.semp: GetMsgVpnDistributedCacheClusterTopicsQueries

Represents the Queries record for the operation: getMsgVpnDistributedCacheClusterTopics

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDistributedCacheQueries

Represents the Queries record for the operation: getMsgVpnDistributedCache

Fields

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

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.

solace.semp: GetMsgVpnDistributedCachesQueries

Represents the Queries record for the operation: getMsgVpnDistributedCaches

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnDmrBridgeQueries

Represents the Queries record for the operation: getMsgVpnDmrBridge

Fields

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

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.

solace.semp: GetMsgVpnDmrBridgesQueries

Represents the Queries record for the operation: getMsgVpnDmrBridges

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnJndiConnectionFactoriesQueries

Represents the Queries record for the operation: getMsgVpnJndiConnectionFactories

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnJndiConnectionFactoryQueries

Represents the Queries record for the operation: getMsgVpnJndiConnectionFactory

Fields

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

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.

solace.semp: GetMsgVpnJndiQueueQueries

Represents the Queries record for the operation: getMsgVpnJndiQueue

Fields

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

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.

solace.semp: GetMsgVpnJndiQueuesQueries

Represents the Queries record for the operation: getMsgVpnJndiQueues

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnJndiTopicQueries

Represents the Queries record for the operation: getMsgVpnJndiTopic

Fields

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

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.

solace.semp: GetMsgVpnJndiTopicsQueries

Represents the Queries record for the operation: getMsgVpnJndiTopics

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnKafkaReceiverQueries

Represents the Queries record for the operation: getMsgVpnKafkaReceiver

Fields

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

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.

solace.semp: GetMsgVpnKafkaReceiversQueries

Represents the Queries record for the operation: getMsgVpnKafkaReceivers

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnKafkaReceiverTopicBindingQueries

Represents the Queries record for the operation: getMsgVpnKafkaReceiverTopicBinding

Fields

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

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.

solace.semp: GetMsgVpnKafkaReceiverTopicBindingsQueries

Represents the Queries record for the operation: getMsgVpnKafkaReceiverTopicBindings

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnKafkaSenderQueries

Represents the Queries record for the operation: getMsgVpnKafkaSender

Fields

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

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.

solace.semp: GetMsgVpnKafkaSenderQueueBindingQueries

Represents the Queries record for the operation: getMsgVpnKafkaSenderQueueBinding

Fields

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

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.

solace.semp: GetMsgVpnKafkaSenderQueueBindingsQueries

Represents the Queries record for the operation: getMsgVpnKafkaSenderQueueBindings

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnKafkaSendersQueries

Represents the Queries record for the operation: getMsgVpnKafkaSenders

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnMqttRetainCacheQueries

Represents the Queries record for the operation: getMsgVpnMqttRetainCache

Fields

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

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.

solace.semp: GetMsgVpnMqttRetainCachesQueries

Represents the Queries record for the operation: getMsgVpnMqttRetainCaches

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnMqttSessionQueries

Represents the Queries record for the operation: getMsgVpnMqttSession

Fields

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

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.

solace.semp: GetMsgVpnMqttSessionsQueries

Represents the Queries record for the operation: getMsgVpnMqttSessions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnMqttSessionSubscriptionQueries

Represents the Queries record for the operation: getMsgVpnMqttSessionSubscription

Fields

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

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.

solace.semp: GetMsgVpnMqttSessionSubscriptionsQueries

Represents the Queries record for the operation: getMsgVpnMqttSessionSubscriptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnProxiesQueries

Represents the Queries record for the operation: getMsgVpnProxies

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnProxyQueries

Represents the Queries record for the operation: getMsgVpnProxy

Fields

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

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.

solace.semp: GetMsgVpnQueries

Represents the Queries record for the operation: getMsgVpn

Fields

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

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.

solace.semp: GetMsgVpnQueueQueries

Represents the Queries record for the operation: getMsgVpnQueue

Fields

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

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.

solace.semp: GetMsgVpnQueuesQueries

Represents the Queries record for the operation: getMsgVpnQueues

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnQueueSubscriptionQueries

Represents the Queries record for the operation: getMsgVpnQueueSubscription

Fields

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

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.

solace.semp: GetMsgVpnQueueSubscriptionsQueries

Represents the Queries record for the operation: getMsgVpnQueueSubscriptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnQueueTemplateQueries

Represents the Queries record for the operation: getMsgVpnQueueTemplate

Fields

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

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.

solace.semp: GetMsgVpnQueueTemplatesQueries

Represents the Queries record for the operation: getMsgVpnQueueTemplates

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnReplayLogQueries

Represents the Queries record for the operation: getMsgVpnReplayLog

Fields

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

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.

solace.semp: GetMsgVpnReplayLogsQueries

Represents the Queries record for the operation: getMsgVpnReplayLogs

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnReplayLogTopicFilterSubscriptionQueries

Represents the Queries record for the operation: getMsgVpnReplayLogTopicFilterSubscription

Fields

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

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.

solace.semp: GetMsgVpnReplayLogTopicFilterSubscriptionsQueries

Represents the Queries record for the operation: getMsgVpnReplayLogTopicFilterSubscriptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnReplicatedTopicQueries

Represents the Queries record for the operation: getMsgVpnReplicatedTopic

Fields

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

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.

solace.semp: GetMsgVpnReplicatedTopicsQueries

Represents the Queries record for the operation: getMsgVpnReplicatedTopics

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPoint

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaders

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBinding

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBindingRequestHeader

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingRequestHeadersQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBindingRequestHeaders

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointQueueBindingsQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointQueueBindings

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumerQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumer

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumersQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumers

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

Fields

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

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.

solace.semp: GetMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames

Fields

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

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnRestDeliveryPointsQueries

Represents the Queries record for the operation: getMsgVpnRestDeliveryPoints

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnSequencedTopicQueries

Represents the Queries record for the operation: getMsgVpnSequencedTopic

Fields

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

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.

solace.semp: GetMsgVpnSequencedTopicsQueries

Represents the Queries record for the operation: getMsgVpnSequencedTopics

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnsQueries

Represents the Queries record for the operation: getMsgVpns

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTelemetryProfileQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfile

Fields

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

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.

solace.semp: GetMsgVpnTelemetryProfileReceiverAclConnectExceptionQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileReceiverAclConnectException

Fields

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

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.

solace.semp: GetMsgVpnTelemetryProfileReceiverAclConnectExceptionsQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileReceiverAclConnectExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTelemetryProfilesQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfiles

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTelemetryProfileTraceFilterQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileTraceFilter

Fields

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

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.

solace.semp: GetMsgVpnTelemetryProfileTraceFiltersQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileTraceFilters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTelemetryProfileTraceFilterSubscriptionQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileTraceFilterSubscription

Fields

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

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.

solace.semp: GetMsgVpnTelemetryProfileTraceFilterSubscriptionsQueries

Represents the Queries record for the operation: getMsgVpnTelemetryProfileTraceFilterSubscriptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTopicEndpointQueries

Represents the Queries record for the operation: getMsgVpnTopicEndpoint

Fields

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

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.

solace.semp: GetMsgVpnTopicEndpointsQueries

Represents the Queries record for the operation: getMsgVpnTopicEndpoints

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetMsgVpnTopicEndpointTemplateQueries

Represents the Queries record for the operation: getMsgVpnTopicEndpointTemplate

Fields

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

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.

solace.semp: GetMsgVpnTopicEndpointTemplatesQueries

Represents the Queries record for the operation: getMsgVpnTopicEndpointTemplates

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: getOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Fields

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

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.

solace.semp: GetOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsQueries

Represents the Queries record for the operation: getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileAccessLevelGroupQueries

Represents the Queries record for the operation: getOauthProfileAccessLevelGroup

Fields

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

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.

solace.semp: GetOauthProfileAccessLevelGroupsQueries

Represents the Queries record for the operation: getOauthProfileAccessLevelGroups

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileClientAllowedHostQueries

Represents the Queries record for the operation: getOauthProfileClientAllowedHost

Fields

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

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.

solace.semp: GetOauthProfileClientAllowedHostsQueries

Represents the Queries record for the operation: getOauthProfileClientAllowedHosts

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileClientAuthorizationParameterQueries

Represents the Queries record for the operation: getOauthProfileClientAuthorizationParameter

Fields

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

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.

solace.semp: GetOauthProfileClientAuthorizationParametersQueries

Represents the Queries record for the operation: getOauthProfileClientAuthorizationParameters

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileClientRequiredClaimQueries

Represents the Queries record for the operation: getOauthProfileClientRequiredClaim

Fields

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

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.

solace.semp: GetOauthProfileClientRequiredClaimsQueries

Represents the Queries record for the operation: getOauthProfileClientRequiredClaims

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileDefaultMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: getOauthProfileDefaultMsgVpnAccessLevelException

Fields

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

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.

solace.semp: GetOauthProfileDefaultMsgVpnAccessLevelExceptionsQueries

Represents the Queries record for the operation: getOauthProfileDefaultMsgVpnAccessLevelExceptions

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfileQueries

Represents the Queries record for the operation: getOauthProfile

Fields

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

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.

solace.semp: GetOauthProfileResourceServerRequiredClaimQueries

Represents the Queries record for the operation: getOauthProfileResourceServerRequiredClaim

Fields

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

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.

solace.semp: GetOauthProfileResourceServerRequiredClaimsQueries

Represents the Queries record for the operation: getOauthProfileResourceServerRequiredClaims

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetOauthProfilesQueries

Represents the Queries record for the operation: getOauthProfiles

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetProxiesQueries

Represents the Queries record for the operation: getProxies

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: GetProxyQueries

Represents the Queries record for the operation: getProxy

Fields

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

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.

solace.semp: GetSystemInformationQueries

Represents the Queries record for the operation: getSystemInformation

Fields

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

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.

solace.semp: GetVirtualHostnameQueries

Represents the Queries record for the operation: getVirtualHostname

Fields

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

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.

solace.semp: GetVirtualHostnamesQueries

Represents the Queries record for the operation: getVirtualHostnames

Fields

cursor? string - The cursor, or position, for the next page of objects. See the documentation for the cursor parameter.

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

count int(default 10) - Limit the count of objects in the response. See the documentation for the count parameter.

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.

'where? string[] - Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

solace.semp: MsgVpn

Fields

alias? string - The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN. Aliases may form a non-circular chain, cascading one to the next. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.14.

allowDmqEligibleEndpointOverrideEnabled? boolean - Enable or disable allowing endpoints to override the DMQ Eligible flag provided by the publisher. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.49.

authenticationBasicEnabled? boolean - Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

authenticationBasicProfileName? string - The name of the RADIUS or LDAP Profile to use for basic authentication. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

authenticationBasicRadiusDomain? string - The RADIUS domain to use for basic authentication. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationBasicType? "internal"|"ldap"|"radius"|"none" - The type of basic authentication to use for clients connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "radius". The allowed values and their meaning are: <pre> "internal" - Internal database. Authentication is against Client Usernames. "ldap" - LDAP authentication. An LDAP profile name must be provided. "radius" - RADIUS authentication. A RADIUS profile name must be provided. "none" - No authentication. Anonymous login allowed. </pre>

authenticationClientCertAllowApiProvidedUsernameEnabled? boolean - Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the system will use the configured username source settings to determine which client username will be used. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

authenticationClientCertCertificateMatchingRulesEnabled? boolean - Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.27.

authenticationClientCertEnabled? boolean - Enable or disable client certificate authentication for clients connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

authenticationClientCertMaxChainDepth? int - The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

authenticationClientCertRevocationCheckMode? "allow-all"|"allow-unknown"|"allow-valid" - The desired behavior for client certificate revocation checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "allow-valid". The allowed values and their meaning are: <pre> "allow-all" - Allow the client to authenticate, the result of client certificate revocation check is ignored. "allow-unknown" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined. "allow-valid" - Allow the client to authenticate only when the revocation check returned an explicit positive response. </pre> Available since 2.6.

authenticationClientCertUsernameSource? "certificate-thumbprint"|"common-name"|"common-name-last"|"subject-alternate-name-msupn"|"uid"|"uid-last" - The field from the client certificate to use as the client username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "common-name". The allowed values and their meaning are: <pre> "certificate-thumbprint" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. "common-name" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. "common-name-last" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. "subject-alternate-name-msupn" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. "uid" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. "uid-last" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. </pre> Available since 2.6.

authenticationClientCertValidateDateEnabled? boolean - Enable or disable validation of the "Not Before" and "Not After" validity dates in the client certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

authenticationKerberosAllowApiProvidedUsernameEnabled? boolean - Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

authenticationKerberosEnabled? boolean - Enable or disable Kerberos authentication for clients connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

authenticationOauthDefaultProfileName? string - The name of the profile to use when the client does not supply a profile name. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.25.

authenticationOauthDefaultProviderName? string - The name of the provider to use when the client does not supply a provider name. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.

authenticationOauthEnabled? boolean - Enable or disable OAuth authentication for clients connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.13.

authorizationLdapGroupMembershipAttributeName? string - The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "memberOf".

authorizationLdapTrimClientUsernameDomainEnabled? boolean - Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurrence of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.13.

authorizationProfileName? string - The name of the LDAP Profile to use for client authorization. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authorizationType? "ldap"|"internal" - The type of authorization to use for clients connecting to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "internal". The allowed values and their meaning are: <pre> "ldap" - LDAP authorization. "internal" - Internal authorization. </pre>

bridgingTlsServerCertEnforceTrustedCommonNameEnabled? boolean - Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

bridgingTlsServerCertMaxChainDepth? int - The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

bridgingTlsServerCertValidateDateEnabled? boolean - Enable or disable validation of the "Not Before" and "Not After" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

bridgingTlsServerCertValidateNameEnabled? boolean - Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

distributedCacheManagementEnabled? boolean - Enable or disable managing of cache instances over the message bus. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". The default value is true. Deprecated since 2.28. Distributed cache management is now redundancy aware and thus no longer requires administrative intervention for operational state.

dmrEnabled? boolean - Enable or disable Dynamic Message Routing (DMR) for the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.11.

enabled? boolean - Enable or disable the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventConnectionCountThreshold? MsgVpnEventConnectionCountThreshold - The thresholds for the client connection count event of the Message VPN, relative to maxConnectionCount.

eventEgressFlowCountThreshold? MsgVpnEventEgressFlowCountThreshold - The thresholds for the egress flow count event of the Message VPN, relative to maxEgressFlowCount.

eventEgressMsgRateThreshold? MsgVpnEventEgressMsgRateThreshold - The thresholds for the egress message rate event of the Message VPN.

eventEndpointCountThreshold? MsgVpnEventEndpointCountThreshold - The thresholds for the Queues and Topic Endpoints count event of the Message VPN, relative to maxEndpointCount.

eventIngressFlowCountThreshold? MsgVpnEventIngressFlowCountThreshold - The thresholds for the receive flow count event of the Message VPN, relative to maxIngressFlowCount.

eventIngressMsgRateThreshold? MsgVpnEventIngressMsgRateThreshold - The thresholds for the receive message rate event of the Message VPN.

eventLargeMsgThreshold? int - The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1024.

eventLogTag? string - A prefix applied to all published Events in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

eventMsgSpoolUsageThreshold? MsgVpnEventMsgSpoolUsageThreshold - The thresholds for the message spool usage event of the Message VPN, relative to maxMsgSpoolUsage.

eventPublishClientEnabled? boolean - Enable or disable Client level Event message publishing. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventPublishMsgVpnEnabled? boolean - Enable or disable Message VPN level Event message publishing. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventPublishSubscriptionMode? "off"|"on-with-format-v1"|"on-with-no-unsubscribe-events-on-disconnect-format-v1"|"on-with-format-v2"|"on-with-no-unsubscribe-events-on-disconnect-format-v2" - Subscription level Event message publishing mode. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "off". The allowed values and their meaning are: <pre> "off" - Disable client level event message publishing. "on-with-format-v1" - Enable client level event message publishing with format v1. "on-with-no-unsubscribe-events-on-disconnect-format-v1" - As "on-with-format-v1", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. "on-with-format-v2" - Enable client level event message publishing with format v2. "on-with-no-unsubscribe-events-on-disconnect-format-v2" - As "on-with-format-v2", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. </pre>

eventPublishTopicFormatMqttEnabled? boolean - Enable or disable Event publish topics in MQTT format. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventPublishTopicFormatSmfEnabled? boolean - Enable or disable Event publish topics in SMF format. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

eventServiceAmqpConnectionCountThreshold? MsgVpnEventServiceAmqpConnectionCountThreshold - The thresholds for the AMQP client connection count event of the Message VPN, relative to serviceAmqpMaxConnectionCount. Available since 2.7.

eventServiceMqttConnectionCountThreshold? MsgVpnEventServiceMqttConnectionCountThreshold - The thresholds for the MQTT client connection count event of the Message VPN, relative to serviceMqttMaxConnectionCount. Available since 2.1.

eventServiceRestIncomingConnectionCountThreshold? MsgVpnEventServiceRestIncomingConnectionCountThreshold - The thresholds for the incoming REST client connection count event of the Message VPN, relative to serviceRestIncomingMaxConnectionCount.

eventServiceSmfConnectionCountThreshold? MsgVpnEventServiceSmfConnectionCountThreshold - The thresholds for the SMF client connection count event of the Message VPN, relative to serviceSmfMaxConnectionCount.

eventServiceWebConnectionCountThreshold? MsgVpnEventServiceWebConnectionCountThreshold - The thresholds for the Web Transport client connection count event of the Message VPN, relative to serviceWebMaxConnectionCount.

eventSubscriptionCountThreshold? MsgVpnEventSubscriptionCountThreshold - The thresholds for the subscription count event of the Message VPN, relative to maxSubscriptionCount.

eventTransactedSessionCountThreshold? MsgVpnEventTransactedSessionCountThreshold - The thresholds for the transacted session count event of the Message VPN, relative to maxTransactedSessionCount.

eventTransactionCountThreshold? MsgVpnEventTransactionCountThreshold - The thresholds for the transaction count event of the Message VPN, relative to maxTransactionCount.

exportSubscriptionsEnabled? boolean - Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

jndiEnabled? boolean - Enable or disable JNDI access for clients in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.2.

maxConnectionCount? int - The maximum number of client connections to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

maxEgressFlowCount? int - The maximum number of transmit flows that can be created in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxEndpointCount? int - The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxIngressFlowCount? int - The maximum number of receive flows that can be created in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxKafkaBrokerConnectionCount? Signed32 - The maximum number of simultaneous Kafka Broker connections of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.39.

maxMsgSpoolUsage? int - The maximum message spool usage by the Message VPN, in megabytes. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

maxSubscriptionCount? int - The maximum number of local subscriptions that can be added to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 500000.

maxTransactedSessionCount? int - The maximum number of transacted sessions that can be created in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

maxTransactionCount? int - The maximum number of transactions that can be created in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

mqttRetainMaxMemory? Signed32 - The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1. Available since 2.11.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

replicationAckPropagationIntervalMsgCount? int - The acknowledgment (ACK) propagation interval for the replication Bridge, in number of replicated messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20.

replicationBridgeAuthenticationBasicClientUsername? string - The Client Username the replication Bridge uses to login to the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

replicationBridgeAuthenticationBasicPassword? string - The password for the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

replicationBridgeAuthenticationClientCertContent? string - The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "". Available since 2.9.

replicationBridgeAuthenticationClientCertPassword? string - The password for the client certificate. The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "". Available since 2.9.

replicationBridgeAuthenticationScheme? "basic"|"client-certificate" - The authentication scheme for the replication Bridge in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "basic". The allowed values and their meaning are: <pre> "basic" - Basic Authentication Scheme (via username and password). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). </pre>

replicationBridgeCompressedDataEnabled? boolean - Enable or disable use of compression for the replication Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

replicationBridgeEgressFlowWindowSize? int - The size of the window used for guaranteed messages published to the replication Bridge, in messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 255.

replicationBridgeRetryDelay? int - The number of seconds that must pass before retrying the replication Bridge connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 3.

replicationBridgeTlsEnabled? boolean - Enable or disable use of encryption (TLS) for the replication Bridge connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

replicationBridgeUnidirectionalClientProfileName? string - The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#client-profile".

replicationEnabled? boolean - Enable or disable replication for the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

replicationEnabledQueueBehavior? "fail-on-existing-queue"|"force-use-existing-queue"|"force-recreate-queue" - The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "fail-on-existing-queue". The allowed values and their meaning are: <pre> "fail-on-existing-queue" - The data replication queue must not already exist. "force-use-existing-queue" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail. "force-recreate-queue" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications. </pre>

replicationQueueMaxMsgSpoolUsage? int - The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60000.

replicationQueueRejectMsgToSenderOnDiscardEnabled? boolean - Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

replicationRejectMsgWhenSyncIneligibleEnabled? boolean - Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

replicationRole? "active"|"standby" - The replication role for the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "standby". The allowed values and their meaning are: <pre> "active" - Assume the Active role in replication for the Message VPN. "standby" - Assume the Standby role in replication for the Message VPN. </pre>

replicationTransactionMode? "sync"|"async" - The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "async". The allowed values and their meaning are: <pre> "sync" - Messages are acknowledged when replicated (spooled remotely). "async" - Messages are acknowledged when pending replication (spooled locally). </pre>

restTlsServerCertEnforceTrustedCommonNameEnabled? boolean - Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

restTlsServerCertMaxChainDepth? int - The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

restTlsServerCertValidateDateEnabled? boolean - Enable or disable validation of the "Not Before" and "Not After" validity dates in the REST Consumer server certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

restTlsServerCertValidateNameEnabled? boolean - Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.17.

sempOverMsgBusAdminClientEnabled? boolean - Enable or disable "admin client" SEMP over the message bus commands for the current Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

sempOverMsgBusAdminDistributedCacheEnabled? boolean - Enable or disable "admin distributed-cache" SEMP over the message bus commands for the current Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

sempOverMsgBusAdminEnabled? boolean - Enable or disable "admin" SEMP over the message bus commands for the current Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

sempOverMsgBusEnabled? boolean - Enable or disable SEMP over the message bus for the current Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

sempOverMsgBusShowEnabled? boolean - Enable or disable "show" SEMP over the message bus commands for the current Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

serviceAmqpMaxConnectionCount? int - The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.

serviceAmqpPlainTextEnabled? boolean - Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.7.

serviceAmqpPlainTextListenPort? int - The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.7.

serviceAmqpTlsEnabled? boolean - Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.7.

serviceAmqpTlsListenPort? int - The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.7.

serviceMqttAuthenticationClientCertRequest? "always"|"never"|"when-enabled-in-message-vpn" - Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-enabled-in-message-vpn". The allowed values and their meaning are: <pre> "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn > authentication > client-certificate > shutdown". </pre> Available since 2.21.

serviceMqttMaxConnectionCount? int - The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.

serviceMqttPlainTextEnabled? boolean - Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.1.

serviceMqttPlainTextListenPort? int - The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.1.

serviceMqttTlsEnabled? boolean - Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.1.

serviceMqttTlsListenPort? int - The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.1.

serviceMqttTlsWebSocketEnabled? boolean - Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.1.

serviceMqttTlsWebSocketListenPort? int - The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.1.

serviceMqttWebSocketEnabled? boolean - Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.1.

serviceMqttWebSocketListenPort? int - The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.1.

serviceRestIncomingAuthenticationClientCertRequest? "always"|"never"|"when-enabled-in-message-vpn" - Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-enabled-in-message-vpn". The allowed values and their meaning are: <pre> "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn > authentication > client-certificate > shutdown". </pre> Available since 2.21.

serviceRestIncomingAuthorizationHeaderHandling? "drop"|"forward"|"legacy" - The handling of Authorization headers for incoming REST connections. Authorization header handling settings apply only when the Message VPN is in gateway mode. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "drop". The allowed values and their meaning are: <pre> "drop" - Do not attach the Authorization header to the message as a user property. This configuration is most secure. "forward" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting. "legacy" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting. </pre> Available since 2.19.

serviceRestIncomingMaxConnectionCount? int - The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

serviceRestIncomingPlainTextEnabled? boolean - Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

serviceRestIncomingPlainTextListenPort? int - The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceRestIncomingPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

serviceRestIncomingTlsEnabled? boolean - Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

serviceRestIncomingTlsListenPort? int - The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceRestIncomingTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

serviceRestMode? "gateway"|"messaging" - The REST service mode for incoming REST clients that connect to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "messaging". The allowed values and their meaning are: <pre> "gateway" - Act as a message gateway through which REST messages are propagated. "messaging" - Act as a message broker on which REST messages are queued. </pre> Available since 2.6.

serviceRestOutgoingMaxConnectionCount? int - The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

serviceSmfMaxConnectionCount? int - The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

serviceSmfPlainTextEnabled? boolean - Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

serviceSmfTlsEnabled? boolean - Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

serviceWebAuthenticationClientCertRequest? "always"|"never"|"when-enabled-in-message-vpn" - Determines when to request a client certificate from a Web Transport client connecting via a TLS port. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-enabled-in-message-vpn". The allowed values and their meaning are: <pre> "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration. "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn > authentication > client-certificate > shutdown". </pre> Available since 2.21.

serviceWebMaxConnectionCount? int - The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

serviceWebPlainTextEnabled? boolean - Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

serviceWebTlsEnabled? boolean - Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

tlsAllowDowngradeToPlainTextEnabled? boolean - Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnAclProfile

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clientConnectDefaultAction? "allow"|"disallow" - The default action to take when a client using the ACL Profile connects to the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "disallow". The allowed values and their meaning are: <pre> "allow" - Allow client connection unless an exception is found for it. "disallow" - Disallow client connection unless an exception is found for it. </pre>

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

publishTopicDefaultAction? "allow"|"disallow" - The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "disallow". The allowed values and their meaning are: <pre> "allow" - Allow topic unless an exception is found for it. "disallow" - Disallow topic unless an exception is found for it. </pre>

subscribeShareNameDefaultAction? "allow"|"disallow" - The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "allow". The allowed values and their meaning are: <pre> "allow" - Allow topic unless an exception is found for it. "disallow" - Disallow topic unless an exception is found for it. </pre> Available since 2.14.

subscribeTopicDefaultAction? "allow"|"disallow" - The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "disallow". The allowed values and their meaning are: <pre> "allow" - Allow topic unless an exception is found for it. "disallow" - Disallow topic unless an exception is found for it. </pre>

solace.semp: MsgVpnAclProfileClientConnectException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clientConnectExceptionAddress? string - The IP address/netmask of the client connect exception in canonical CIDR form. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnAclProfileClientConnectExceptionLinks

Fields

uri? string - The URI of this Client Connect Exception object.

solace.semp: MsgVpnAclProfileClientConnectExceptionResponse

Fields

data? MsgVpnAclProfileClientConnectException -

links? MsgVpnAclProfileClientConnectExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfileClientConnectExceptionsResponse

Fields

data? MsgVpnAclProfileClientConnectException[] -

links? MsgVpnAclProfileClientConnectExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfileLinks

Fields

clientConnectExceptionsUri? string - The URI of this ACL Profile's collection of Client Connect Exception objects.

publishExceptionsUri? string - The URI of this ACL Profile's collection of Publish Topic Exception objects. Deprecated since 2.14. Replaced by publishTopicExceptions.

publishTopicExceptionsUri? string - The URI of this ACL Profile's collection of Publish Topic Exception objects. Available since 2.14.

subscribeExceptionsUri? string - The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions.

subscribeShareNameExceptionsUri? string - The URI of this ACL Profile's collection of Subscribe Share Name Exception objects. Available since 2.14.

subscribeTopicExceptionsUri? string - The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Available since 2.14.

uri? string - The URI of this ACL Profile object.

solace.semp: MsgVpnAclProfilePublishException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by publishTopicExceptions.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by publishTopicExceptions.

publishExceptionTopic? string - The topic for the exception to the default action taken. May include wildcard characters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by publishTopicExceptions.

topicSyntax? "smf"|"mqtt" - The syntax of the topic for the exception to the default action taken. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by publishTopicExceptions.

solace.semp: MsgVpnAclProfilePublishExceptionLinks

Fields

uri? string - The URI of this Publish Topic Exception object.

solace.semp: MsgVpnAclProfilePublishExceptionResponse

Fields

data? MsgVpnAclProfilePublishException -

links? MsgVpnAclProfilePublishExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfilePublishExceptionsResponse

Fields

data? MsgVpnAclProfilePublishException[] -

links? MsgVpnAclProfilePublishExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfilePublishTopicException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

publishTopicException? string - The topic for the exception to the default action taken. May include wildcard characters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

publishTopicExceptionSyntax? "smf"|"mqtt" - The syntax of the topic for the exception to the default action taken. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. </pre>

solace.semp: MsgVpnAclProfilePublishTopicExceptionLinks

Fields

uri? string - The URI of this Publish Topic Exception object.

solace.semp: MsgVpnAclProfilePublishTopicExceptionResponse

Fields

data? MsgVpnAclProfilePublishTopicException -

links? MsgVpnAclProfilePublishTopicExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfilePublishTopicExceptionsResponse

Fields

data? MsgVpnAclProfilePublishTopicException[] -

links? MsgVpnAclProfilePublishTopicExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfileResponse

Fields

data? MsgVpnAclProfile -

links? MsgVpnAclProfileLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfilesResponse

Fields

data? MsgVpnAclProfile[] -

links? MsgVpnAclProfileLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by subscribeTopicExceptions.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by subscribeTopicExceptions.

subscribeExceptionTopic? string - The topic for the exception to the default action taken. May include wildcard characters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.14. Replaced by subscribeTopicExceptions.

topicSyntax? "smf"|"mqtt" - The syntax of the topic for the exception to the default action taken. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by subscribeTopicExceptions.

solace.semp: MsgVpnAclProfileSubscribeExceptionLinks

Fields

uri? string - The URI of this Subscribe Topic Exception object.

solace.semp: MsgVpnAclProfileSubscribeExceptionResponse

Fields

data? MsgVpnAclProfileSubscribeException -

links? MsgVpnAclProfileSubscribeExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeExceptionsResponse

Fields

data? MsgVpnAclProfileSubscribeException[] -

links? MsgVpnAclProfileSubscribeExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeShareNameException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscribeShareNameException? string - The subscribe share name exception to the default action taken. May include wildcard characters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscribeShareNameExceptionSyntax? "smf"|"mqtt" - The syntax of the subscribe share name for the exception to the default action taken. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. </pre>

solace.semp: MsgVpnAclProfileSubscribeShareNameExceptionLinks

Fields

uri? string - The URI of this Subscribe Share Name Exception object.

solace.semp: MsgVpnAclProfileSubscribeShareNameExceptionResponse

Fields

data? MsgVpnAclProfileSubscribeShareNameException -

links? MsgVpnAclProfileSubscribeShareNameExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeShareNameExceptionsResponse

Fields

data? MsgVpnAclProfileSubscribeShareNameException[] -

links? MsgVpnAclProfileSubscribeShareNameExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeTopicException

Fields

aclProfileName? string - The name of the ACL Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscribeTopicException? string - The topic for the exception to the default action taken. May include wildcard characters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscribeTopicExceptionSyntax? "smf"|"mqtt" - The syntax of the topic for the exception to the default action taken. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. </pre>

solace.semp: MsgVpnAclProfileSubscribeTopicExceptionLinks

Fields

uri? string - The URI of this Subscribe Topic Exception object.

solace.semp: MsgVpnAclProfileSubscribeTopicExceptionResponse

Fields

data? MsgVpnAclProfileSubscribeTopicException -

links? MsgVpnAclProfileSubscribeTopicExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnAclProfileSubscribeTopicExceptionsResponse

Fields

data? MsgVpnAclProfileSubscribeTopicException[] -

links? MsgVpnAclProfileSubscribeTopicExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthenticationKerberosRealm

Fields

enabled? boolean - Enable or disable the Realm. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

kdcAddress? string - Address (FQDN or IP) and optional port of the Key Distribution Center for principals in this Realm. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

kerberosRealmName? string - The Realm Name. Must start with "@", typically all uppercase. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnAuthenticationKerberosRealmLinks

Fields

uri? string - The URI of this Realm object.

solace.semp: MsgVpnAuthenticationKerberosRealmResponse

Fields

data? MsgVpnAuthenticationKerberosRealm -

links? MsgVpnAuthenticationKerberosRealmLinks -

meta SempMeta -

solace.semp: MsgVpnAuthenticationKerberosRealmsResponse

Fields

data? MsgVpnAuthenticationKerberosRealm[] -

links? MsgVpnAuthenticationKerberosRealmLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfile

Fields

authorizationGroupsClaimName? string - The name of the groups claim. If non-empty, the specified claim will be used to determine groups for authorization. If empty, the authorizationType attribute of the Message VPN will be used to determine authorization. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "groups".

authorizationGroupsClaimStringFormat? "single"|"space-delimited" - The format of the authorization groups claim value when it is a string. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "single". The allowed values and their meaning are: <pre> "single" - When the claim is a string, it is interpreted as as single group. "space-delimited" - When the claim is a string, it is interpreted as a space-delimited list of groups, similar to the "scope" claim. </pre> Available since 2.32.

clientId? string - The OAuth client id. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

clientRequiredType? string - The required value for the TYP field in the ID token header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "JWT".

clientSecret? string - The OAuth client secret. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

clientValidateTypeEnabled? boolean - Enable or disable verification of the TYP field in the ID token header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

disconnectOnTokenExpirationEnabled? boolean - Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

enabled? boolean - Enable or disable the OAuth profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

endpointDiscovery? string - The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

endpointDiscoveryRefreshInterval? Signed32 - The number of seconds between discovery endpoint requests. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 86400.

endpointIntrospection? string - The OAuth introspection endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

endpointIntrospectionTimeout? Signed32 - The maximum time in seconds a token introspection request is allowed to take. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

endpointJwks? string - The OAuth JWKS endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

endpointJwksRefreshInterval? Signed32 - The number of seconds between JWKS endpoint requests. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 86400.

endpointUserinfo? string - The OpenID Connect Userinfo endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

endpointUserinfoTimeout? Signed32 - The maximum time in seconds a userinfo request is allowed to take. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

issuer? string - The Issuer Identifier for the OAuth provider. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

mqttUsernameValidateEnabled? boolean - Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthRole? "client"|"resource-server" - The OAuth role of the broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "client". The allowed values and their meaning are: <pre> "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. </pre>

proxyName? string - The name of the proxy to use for discovery, user info, jwks, and introspection requests. Leave empty for no proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.41.

resourceServerParseAccessTokenEnabled? boolean - Enable or disable parsing of the access token as a JWT. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

resourceServerRequiredAudience? string - The required audience value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

resourceServerRequiredIssuer? string - The required issuer value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

resourceServerRequiredScope? string - A space-separated list of scopes that must be present in the scope claim. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

resourceServerRequiredType? string - The required TYP value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "at+jwt".

resourceServerValidateAudienceEnabled? boolean - Enable or disable verification of the audience claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

resourceServerValidateIssuerEnabled? boolean - Enable or disable verification of the issuer claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

resourceServerValidateScopeEnabled? boolean - Enable or disable verification of the scope claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

resourceServerValidateTypeEnabled? boolean - Enable or disable verification of the TYP field in the access token header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

usernameClaimName? string - The name of the username claim. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "sub".

solace.semp: MsgVpnAuthenticationOauthProfileClientRequiredClaim

Fields

clientRequiredClaimName? string - The name of the ID token claim to verify. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clientRequiredClaimValue? string - The required claim value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks

Fields

uri? string - The URI of this Required Claim object.

solace.semp: MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse

Fields

data? MsgVpnAuthenticationOauthProfileClientRequiredClaim -

links? MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse

Fields

data? MsgVpnAuthenticationOauthProfileClientRequiredClaim[] -

links? MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfileLinks

Fields

clientRequiredClaimsUri? string - The URI of this OAuth Profile's collection of Required Claim objects.

resourceServerRequiredClaimsUri? string - The URI of this OAuth Profile's collection of Required Claim objects.

uri? string - The URI of this OAuth Profile object.

solace.semp: MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

resourceServerRequiredClaimName? string - The name of the access token claim to verify. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

resourceServerRequiredClaimValue? string - The required claim value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks

Fields

uri? string - The URI of this Required Claim object.

solace.semp: MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse

Fields

data? MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim -

links? MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse

Fields

data? MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim[] -

links? MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfileResponse

Fields

data? MsgVpnAuthenticationOauthProfile -

links? MsgVpnAuthenticationOauthProfileLinks -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProfilesResponse

Fields

data? MsgVpnAuthenticationOauthProfile[] -

links? MsgVpnAuthenticationOauthProfileLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProvider

Fields

audienceClaimName? string - The audience claim name, indicating which part of the object to use for determining the audience. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "aud". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

audienceClaimSource? "access-token"|"id-token"|"introspection" - The audience claim source, indicating where to search for the audience value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "id-token". The allowed values and their meaning are: <pre> "access-token" - The OAuth v2 access_token. "id-token" - The OpenID Connect id_token. "introspection" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

audienceClaimValue? string - The required audience value for a token to be considered valid. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

audienceValidationEnabled? boolean - Enable or disable audience validation. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

authorizationGroupClaimName? string - The authorization group claim name, indicating which part of the object to use for determining the authorization group. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "scope". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

authorizationGroupClaimSource? "access-token"|"id-token"|"introspection" - The authorization group claim source, indicating where to search for the authorization group name. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "id-token". The allowed values and their meaning are: <pre> "access-token" - The OAuth v2 access_token. "id-token" - The OpenID Connect id_token. "introspection" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

authorizationGroupEnabled? boolean - Enable or disable OAuth based authorization. When enabled, the configured authorization type for OAuth clients is overridden. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

disconnectOnTokenExpirationEnabled? boolean - Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

enabled? boolean - Enable or disable OAuth Provider client authentication. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

jwksRefreshInterval? Signed32 - The number of seconds between forced JWKS public key refreshing. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 86400. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

jwksUri? string - The URI where the OAuth provider publishes its JWKS public keys. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.25. Replaced by authenticationOauthProfiles.

oauthProviderName? string - The name of the OAuth Provider. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.25. Replaced by authenticationOauthProfiles.

tokenIgnoreTimeLimitsEnabled? boolean - Enable or disable whether to ignore time limits and accept tokens that are not yet valid or are no longer valid. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

tokenIntrospectionParameterName? string - The parameter name used to identify the token during access token introspection. A standards compliant OAuth introspection server expects "token". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "token". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

tokenIntrospectionPassword? string - The password to use when logging into the token introspection URI. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

tokenIntrospectionTimeout? Signed32 - The maximum time in seconds a token introspection is allowed to take. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

tokenIntrospectionUri? string - The token introspection URI of the OAuth authentication server. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

tokenIntrospectionUsername? string - The username to use when logging into the token introspection URI. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

usernameClaimName? string - The username claim name, indicating which part of the object to use for determining the username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "sub". Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

usernameClaimSource? "access-token"|"id-token"|"introspection" - The username claim source, indicating where to search for the username value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "id-token". The allowed values and their meaning are: <pre> "access-token" - The OAuth v2 access_token. "id-token" - The OpenID Connect id_token. "introspection" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

usernameValidateEnabled? boolean - Enable or disable whether the API provided username will be validated against the username calculated from the token(s); the connection attempt is rejected if they differ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.

solace.semp: MsgVpnAuthenticationOauthProviderLinks

Fields

uri? string - The URI of this OAuth Provider object.

solace.semp: MsgVpnAuthenticationOauthProviderResponse

Fields

data? MsgVpnAuthenticationOauthProvider -

links? MsgVpnAuthenticationOauthProviderLinks -

meta SempMeta -

solace.semp: MsgVpnAuthenticationOauthProvidersResponse

Fields

data? MsgVpnAuthenticationOauthProvider[] -

links? MsgVpnAuthenticationOauthProviderLinks[] -

meta SempMeta -

solace.semp: MsgVpnAuthorizationGroup

Fields

aclProfileName? string - The ACL Profile of the Authorization Group. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

authorizationGroupName? string - The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with ''. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test#,lab,com'. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clientProfileName? string - The Client Profile of the Authorization Group. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

enabled? boolean - Enable or disable the Authorization Group in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

orderAfterAuthorizationGroupName? string - Lower the priority to be less than this group. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

orderBeforeAuthorizationGroupName? string - Raise the priority to be greater than this group. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnAuthorizationGroupLinks

Fields

uri? string - The URI of this Authorization Group object.

solace.semp: MsgVpnAuthorizationGroupResponse

Fields

data? MsgVpnAuthorizationGroup -

links? MsgVpnAuthorizationGroupLinks -

meta SempMeta -

solace.semp: MsgVpnAuthorizationGroupsResponse

Fields

data? MsgVpnAuthorizationGroup[] -

links? MsgVpnAuthorizationGroupLinks[] -

meta SempMeta -

solace.semp: MsgVpnBridge

Fields

bridgeName? string - The name of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

bridgeVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The Bridge is used for the primary virtual router. "backup" - The Bridge is used for the backup virtual router. "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre>

enabled? boolean - Enable or disable the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

maxTtl? int - The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 8.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteAuthenticationBasicClientUsername? string - The Client Username the Bridge uses to login to the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remoteAuthenticationBasicPassword? string - The password for the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remoteAuthenticationClientCertContent? string - The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.9.

remoteAuthenticationClientCertPassword? string - The password for the client certificate. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.9.

remoteAuthenticationScheme? "basic"|"client-certificate"|"tls-psk" - The authentication scheme for the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "basic". The allowed values and their meaning are: <pre> "basic" - Basic Authentication Scheme (via username and password). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). "tls-psk" - This authentication scheme is used internally by the broker. It cannot be directly configured by a user. </pre>

remoteConnectionRetryCount? int - The number of retry attempts to establish a connection before moving on to the next remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

remoteConnectionRetryDelay? int - The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

remoteDeliverToOnePriority? "p1"|"p2"|"p3"|"p4"|"da" - The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "p1". The allowed values and their meaning are: <pre> "p1" - The 1st or highest priority. "p2" - The 2nd highest priority. "p3" - The 3rd highest priority. "p4" - The 4th highest priority. "da" - Ignore priority and deliver always. </pre>

tlsCipherSuiteList? string - The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN when using TLS 1.2 and lower. The value "default" implies all supported suites ordered from most secure to least secure. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

solace.semp: MsgVpnBridgeLinks

Fields

remoteMsgVpnsUri? string - The URI of this Bridge's collection of Remote Message VPN objects.

remoteSubscriptionsUri? string - The URI of this Bridge's collection of Remote Subscription objects.

tlsTrustedCommonNamesUri? string - The URI of this Bridge's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

uri? string - The URI of this Bridge object.

solace.semp: MsgVpnBridgeRemoteMsgVpn

Fields

bridgeName? string - The name of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

bridgeVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The Bridge is used for the primary virtual router. "backup" - The Bridge is used for the backup virtual router. "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre>

clientUsername? string - The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

compressedDataEnabled? boolean - Enable or disable data compression for the remote Message VPN connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

connectOrder? Signed32 - The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

egressFlowWindowSize? int - The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgment is received. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

enabled? boolean - Enable or disable the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

password? string - The password for the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

queueBinding? string - The queue binding of the Bridge in the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remoteMsgVpnInterface? string - The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteMsgVpnLocation? string - The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:"). The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteMsgVpnName? string - The name of the remote Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

tlsEnabled? boolean - Enable or disable encryption (TLS) for the remote Message VPN connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

unidirectionalClientProfile? string - The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2 MB. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#client-profile".

solace.semp: MsgVpnBridgeRemoteMsgVpnLinks

Fields

uri? string - The URI of this Remote Message VPN object.

solace.semp: MsgVpnBridgeRemoteMsgVpnResponse

Fields

data? MsgVpnBridgeRemoteMsgVpn -

links? MsgVpnBridgeRemoteMsgVpnLinks -

meta SempMeta -

solace.semp: MsgVpnBridgeRemoteMsgVpnsResponse

Fields

data? MsgVpnBridgeRemoteMsgVpn[] -

links? MsgVpnBridgeRemoteMsgVpnLinks[] -

meta SempMeta -

solace.semp: MsgVpnBridgeRemoteSubscription

Fields

bridgeName? string - The name of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

bridgeVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The Bridge is used for the primary virtual router. "backup" - The Bridge is used for the backup virtual router. "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre>

deliverAlwaysEnabled? boolean - Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteSubscriptionTopic? string - The topic of the Bridge remote subscription. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnBridgeRemoteSubscriptionLinks

Fields

uri? string - The URI of this Remote Subscription object.

solace.semp: MsgVpnBridgeRemoteSubscriptionResponse

Fields

data? MsgVpnBridgeRemoteSubscription -

links? MsgVpnBridgeRemoteSubscriptionLinks -

meta SempMeta -

solace.semp: MsgVpnBridgeRemoteSubscriptionsResponse

Fields

data? MsgVpnBridgeRemoteSubscription[] -

links? MsgVpnBridgeRemoteSubscriptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnBridgeResponse

Fields

data? MsgVpnBridge -

links? MsgVpnBridgeLinks -

meta SempMeta -

solace.semp: MsgVpnBridgesResponse

Fields

data? MsgVpnBridge[] -

links? MsgVpnBridgeLinks[] -

meta SempMeta -

solace.semp: MsgVpnBridgeTlsTrustedCommonName

Fields

bridgeName? string - The name of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

bridgeVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The Bridge is used for the primary virtual router. "backup" - The Bridge is used for the backup virtual router. "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

tlsTrustedCommonName? string - The expected trusted common name of the remote certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.

solace.semp: MsgVpnBridgeTlsTrustedCommonNameLinks

Fields

uri? string - The URI of this Trusted Common Name object.

solace.semp: MsgVpnBridgeTlsTrustedCommonNameResponse

Fields

data? MsgVpnBridgeTlsTrustedCommonName -

links? MsgVpnBridgeTlsTrustedCommonNameLinks -

meta SempMeta -

solace.semp: MsgVpnBridgeTlsTrustedCommonNamesResponse

Fields

data? MsgVpnBridgeTlsTrustedCommonName[] -

links? MsgVpnBridgeTlsTrustedCommonNameLinks[] -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRule

Fields

enabled? boolean - Enable or disable a certificate matching rule. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnCertMatchingRuleAttributeFilter

Fields

attributeName? string - Client Username Attribute to be tested. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

attributeValue? string - Expected attribute value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

filterName? string - The name of the filter. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnCertMatchingRuleAttributeFilterLinks

Fields

uri? string - The URI of this Certificate Matching Rule Attribute Filter object.

solace.semp: MsgVpnCertMatchingRuleAttributeFilterResponse

Fields

data? MsgVpnCertMatchingRuleAttributeFilter -

links? MsgVpnCertMatchingRuleAttributeFilterLinks -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRuleAttributeFiltersResponse

Fields

data? MsgVpnCertMatchingRuleAttributeFilter[] -

links? MsgVpnCertMatchingRuleAttributeFilterLinks[] -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRuleCondition

Fields

attribute? string - Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The default value is "".

expression? string - Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The default value is "".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

ruleName? string - The name of the rule. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

'source? "certificate-thumbprint"|"common-name"|"common-name-last"|"subject-alternate-name-msupn"|"uid"|"uid-last"|"org-unit"|"org-unit-last"|"issuer"|"subject"|"serial-number"|"dns-name"|"ip-address" - Certificate field to be compared with the Attribute. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "certificate-thumbprint" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. "common-name" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. "common-name-last" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. "subject-alternate-name-msupn" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. "uid" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. "uid-last" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. "org-unit" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. "org-unit-last" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. "issuer" - The attribute is extracted from the certificate's Issuer DN. "subject" - The attribute is extracted from the certificate's Subject DN. "serial-number" - The attribute is extracted from the certificate's Serial Number. "dns-name" - The attribute is extracted from the certificate's Subject Alt Name DNS Name. "ip-address" - The attribute is extracted from the certificate's Subject Alt Name IP Address. </pre>

solace.semp: MsgVpnCertMatchingRuleConditionLinks

Fields

uri? string - The URI of this Certificate Matching Rule Condition object.

solace.semp: MsgVpnCertMatchingRuleConditionResponse

Fields

data? MsgVpnCertMatchingRuleCondition -

links? MsgVpnCertMatchingRuleConditionLinks -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRuleConditionsResponse

Fields

data? MsgVpnCertMatchingRuleCondition[] -

links? MsgVpnCertMatchingRuleConditionLinks[] -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRuleLinks

Fields

attributeFiltersUri? string - The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. Available since 2.28.

conditionsUri? string - The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.

uri? string - The URI of this Certificate Matching Rule object.

solace.semp: MsgVpnCertMatchingRuleResponse

Fields

data? MsgVpnCertMatchingRule -

links? MsgVpnCertMatchingRuleLinks -

meta SempMeta -

solace.semp: MsgVpnCertMatchingRulesResponse

Fields

data? MsgVpnCertMatchingRule[] -

links? MsgVpnCertMatchingRuleLinks[] -

meta SempMeta -

solace.semp: MsgVpnClientProfile

Fields

allowBridgeConnectionsEnabled? boolean - Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

allowCutThroughForwardingEnabled? boolean - Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features.

allowGuaranteedEndpointCreateDurability? "all"|"durable"|"non-durable" - The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "all". The allowed values and their meaning are: <pre> "all" - Client can create any type of endpoint. "durable" - Client can create only durable endpoints. "non-durable" - Client can create only non-durable endpoints. </pre> Available since 2.14.

allowGuaranteedEndpointCreateEnabled? boolean - Enable or disable allowing clients using the Client Profile to create topic endpoints or queues. Changing this value does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

allowGuaranteedMsgReceiveEnabled? boolean - Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

allowGuaranteedMsgSendEnabled? boolean - Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

allowSharedSubscriptionsEnabled? boolean - Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.11.

allowTransactedSessionsEnabled? boolean - Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

apiQueueManagementCopyFromOnCreateName? string - The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.14. This attribute has been replaced with apiQueueManagementCopyFromOnCreateTemplateName.

apiQueueManagementCopyFromOnCreateTemplateName? string - The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.14.

apiTopicEndpointManagementCopyFromOnCreateName? string - The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.14. This attribute has been replaced with apiTopicEndpointManagementCopyFromOnCreateTemplateName.

apiTopicEndpointManagementCopyFromOnCreateTemplateName? string - The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.14.

clientProfileName? string - The name of the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

compressionEnabled? boolean - Enable or disable allowing clients using the Client Profile to use compression. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.10.

elidingDelay? int - The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

elidingEnabled? boolean - Enable or disable message eliding for clients using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

elidingMaxTopicCount? int - The maximum number of topics tracked for message eliding per client connection using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 256.

eventClientProvisionedEndpointSpoolUsageThreshold? MsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold - The thresholds for the message spool usage event of Queues and Topic Endpoints provisioned by clients, relative to maxMsgSpoolUsage for these Queues and Topic Endpoints. Changing these values during operation does not affect existing sessions. For provisioned durable Queues and Topic Endpoints, this value applies when initially provisioned, but can then be changed afterwards by configuring the Queue or Topic Endpoint.

eventConnectionCountPerClientUsernameThreshold? MsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold - The thresholds for the Client Username connection count event of the Client Profile, relative to maxConnectionCountPerClientUsername.

eventEgressFlowCountThreshold? MsgVpnClientProfileEventEgressFlowCountThreshold - The thresholds for the transmit flow count event of the Client Profile, relative to maxEgressFlowCount.

eventEndpointCountPerClientUsernameThreshold? MsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold - The thresholds for the Client Username endpoint count event of the Client Profile, relative to maxEndpointCountPerClientUsername.

eventIngressFlowCountThreshold? MsgVpnClientProfileEventIngressFlowCountThreshold - The thresholds for the receive flow count event of the Client Profile, relative to maxIngressFlowCount.

eventServiceSmfConnectionCountPerClientUsernameThreshold? MsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold - The thresholds for the client username SMF connection count event of the Client Profile, relative to serviceSmfMaxConnectionCountPerClientUsername.

eventServiceWebConnectionCountPerClientUsernameThreshold? MsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold - The thresholds for the Client Username Web Transport connection count event of the Client Profile, relative to serviceWebMaxConnectionCountPerClientUsername.

eventSubscriptionCountThreshold? MsgVpnClientProfileEventSubscriptionCountThreshold - The thresholds for the subscription count event of the Client Profile, relative to maxSubscriptionCount.

eventTransactedSessionCountThreshold? MsgVpnClientProfileEventTransactedSessionCountThreshold - The thresholds for the transacted session count event of the Client Profile, relative to maxTransactedSessionCount.

eventTransactionCountThreshold? MsgVpnClientProfileEventTransactionCountThreshold - The thresholds for the transaction count event of the Client Profile, relative to maxTransactionCount.

maxAmqpLinkCount? Signed32 - The maximum number of AMQP links per AMQP client using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 146625. Available since 2.46.

maxConnectionCountPerClientUsername? int - The maximum number of client connections per Client Username using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

maxEgressFlowCount? int - The maximum number of transmit flows that can be created by one client using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxEndpointCountPerClientUsername? int - The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxIngressFlowCount? int - The maximum number of receive flows that can be created by one client using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxMsgsPerTransaction? Signed32 - The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 256. Available since 2.20.

maxSubscriptionCount? int - The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

maxTransactedSessionCount? int - The maximum number of transacted sessions that can be created by one client using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10.

maxTransactionCount? int - The maximum number of transactions that can be created by one client using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

queueControl1MaxDepth? Signed32 - The maximum depth of the "Control 1" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20000.

queueControl1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Control 1" (C-1) priority queue, regardless of the queueControl1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

queueDirect1MaxDepth? Signed32 - The maximum depth of the "Direct 1" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20000.

queueDirect1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 1" (D-1) priority queue, regardless of the queueDirect1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

queueDirect2MaxDepth? Signed32 - The maximum depth of the "Direct 2" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20000.

queueDirect2MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 2" (D-2) priority queue, regardless of the queueDirect2MaxDepth value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

queueDirect3MaxDepth? Signed32 - The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20000.

queueDirect3MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the queueDirect3MaxDepth value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

queueGuaranteed1MaxDepth? Signed32 - The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 20000.

queueGuaranteed1MinMsgBurst? Signed32 - The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the queueGuaranteed1MaxDepth value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

rejectMsgToSenderOnNoSubscriptionMatchEnabled? boolean - Enable or disable the sending of a negative acknowledgment (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.2.

replicationAllowClientConnectWhenStandbyEnabled? boolean - Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

serviceMinKeepaliveTimeout? Signed32 - The minimum client keepalive timeout which will be enforced for client connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30. Available since 2.19.

serviceSmfMaxConnectionCountPerClientUsername? int - The maximum number of SMF client connections per Client Username using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

serviceSmfMinKeepaliveEnabled? boolean - Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.19.

serviceWebInactiveTimeout? int - The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30.

serviceWebMaxConnectionCountPerClientUsername? int - The maximum number of Web Transport client connections per Client Username using the Client Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

serviceWebMaxPayload? int - The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000000.

tcpCongestionWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". The default value is 2. Deprecated since 2.48. The value is now ignored.

tcpKeepaliveCount? int - The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5.

tcpKeepaliveIdleTime? int - The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

tcpKeepaliveInterval? int - The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

tcpMaxSegmentSize? int - The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1460.

tcpMaxWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". The default value is 256. Deprecated since 2.48. The value is now ignored.

tlsAllowDowngradeToPlainTextEnabled? boolean - Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.8.

solace.semp: MsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold

The thresholds for the message spool usage event of Queues and Topic Endpoints provisioned by clients, relative to maxMsgSpoolUsage for these Queues and Topic Endpoints. Changing these values during operation does not affect existing sessions. For provisioned durable Queues and Topic Endpoints, this value applies when initially provisioned, but can then be changed afterwards by configuring the Queue or Topic Endpoint.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

solace.semp: MsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold

The thresholds for the Client Username connection count event of the Client Profile, relative to maxConnectionCountPerClientUsername.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventEgressFlowCountThreshold

The thresholds for the transmit flow count event of the Client Profile, relative to maxEgressFlowCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold

The thresholds for the Client Username endpoint count event of the Client Profile, relative to maxEndpointCountPerClientUsername.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventIngressFlowCountThreshold

The thresholds for the receive flow count event of the Client Profile, relative to maxIngressFlowCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold

The thresholds for the client username SMF connection count event of the Client Profile, relative to serviceSmfMaxConnectionCountPerClientUsername.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold

The thresholds for the Client Username Web Transport connection count event of the Client Profile, relative to serviceWebMaxConnectionCountPerClientUsername.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventSubscriptionCountThreshold

The thresholds for the subscription count event of the Client Profile, relative to maxSubscriptionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventTransactedSessionCountThreshold

The thresholds for the transacted session count event of the Client Profile, relative to maxTransactedSessionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileEventTransactionCountThreshold

The thresholds for the transaction count event of the Client Profile, relative to maxTransactionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnClientProfileLinks

Fields

uri? string - The URI of this Client Profile object.

solace.semp: MsgVpnClientProfileResponse

Fields

data? MsgVpnClientProfile -

links? MsgVpnClientProfileLinks -

meta SempMeta -

solace.semp: MsgVpnClientProfilesResponse

Fields

data? MsgVpnClientProfile[] -

links? MsgVpnClientProfileLinks[] -

meta SempMeta -

solace.semp: MsgVpnClientUsername

Fields

aclProfileName? string - The ACL Profile of the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

clientProfileName? string - The Client Profile of the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

clientUsername? string - The name of the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

enabled? boolean - Enable or disable the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

guaranteedEndpointPermissionOverrideEnabled? boolean - Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

password? string - The password for the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

subscriptionManagerEnabled? boolean - Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnClientUsernameAttribute

Fields

attributeName? string - The name of the Attribute. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

attributeValue? string - The value of the Attribute. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clientUsername? string - The name of the Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnClientUsernameAttributeLinks

Fields

uri? string - The URI of this Client Username Attribute object.

solace.semp: MsgVpnClientUsernameAttributeResponse

Fields

data? MsgVpnClientUsernameAttribute -

links? MsgVpnClientUsernameAttributeLinks -

meta SempMeta -

solace.semp: MsgVpnClientUsernameAttributesResponse

Fields

data? MsgVpnClientUsernameAttribute[] -

links? MsgVpnClientUsernameAttributeLinks[] -

meta SempMeta -

solace.semp: MsgVpnClientUsernameLinks

Fields

attributesUri? string - The URI of this Client Username's collection of Client Username Attribute objects. Available since 2.27.

uri? string - The URI of this Client Username object.

solace.semp: MsgVpnClientUsernameResponse

Fields

data? MsgVpnClientUsername -

links? MsgVpnClientUsernameLinks -

meta SempMeta -

solace.semp: MsgVpnClientUsernamesResponse

Fields

data? MsgVpnClientUsername[] -

links? MsgVpnClientUsernameLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCache

Fields

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

cacheVirtualRouter? "auto" - The virtual router of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The default value is "auto". The allowed values and their meaning are: <pre> "auto" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Available since 2.28.

enabled? boolean - Enable or disable the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

heartbeat? int - The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

scheduledDeleteMsgDayList? string - The scheduled delete message day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduledDeleteMsgTimeList" must also be configured to the empty-string). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

scheduledDeleteMsgTimeList? string - The scheduled delete message time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduledDeleteMsgDayList" must also be configured to the empty-string). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

solace.semp: MsgVpnDistributedCacheCluster

Fields

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clusterName? string - The name of the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

deliverToOneOverrideEnabled? boolean - Enable or disable deliver-to-one override for the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

enabled? boolean - Enable or disable the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventDataByteRateThreshold? MsgVpnDistributedCacheClusterEventDataByteRateThreshold - The thresholds for the cached data incoming byte rate event, in bytes per second.

eventDataMsgRateThreshold? MsgVpnDistributedCacheClusterEventDataMsgRateThreshold - The thresholds for the cached data incoming message rate event, in messages per second.

eventMaxMemoryThreshold? MsgVpnDistributedCacheClusterEventMaxMemoryThreshold - The thresholds for the memory usage per instance event, relative to maxMemory.

eventMaxTopicsThreshold? MsgVpnDistributedCacheClusterEventMaxTopicsThreshold - The thresholds for the topics per instance event, relative to maxTopicCount.

eventRequestQueueDepthThreshold? MsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold - The thresholds for the request queue depth event, relative to maxRequestQueueDepth.

eventRequestRateThreshold? MsgVpnDistributedCacheClusterEventRequestRateThreshold - The thresholds for the cache request message rate event, in messages per second.

eventResponseRateThreshold? MsgVpnDistributedCacheClusterEventResponseRateThreshold - The thresholds for the cache response message rate event, in messages per second.

globalCachingEnabled? boolean - Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

globalCachingHeartbeat? int - The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

globalCachingTopicLifetime? int - The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3600.

maxMemory? int - The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2048.

maxMsgsPerTopic? int - The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

maxRequestQueueDepth? int - The maximum queue depth for cache requests received by the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 100000.

maxTopicCount? int - The maximum number of topics for each Cache Instance in the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2000000.

msgLifetime? int - The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

newTopicAdvertisementEnabled? boolean - Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnDistributedCacheClusterEventDataByteRateThreshold

The thresholds for the cached data incoming byte rate event, in bytes per second.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 187500000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 250000000.

solace.semp: MsgVpnDistributedCacheClusterEventDataMsgRateThreshold

The thresholds for the cached data incoming message rate event, in messages per second.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 36000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 48000.

solace.semp: MsgVpnDistributedCacheClusterEventMaxMemoryThreshold

The thresholds for the memory usage per instance event, relative to maxMemory.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

solace.semp: MsgVpnDistributedCacheClusterEventMaxTopicsThreshold

The thresholds for the topics per instance event, relative to maxTopicCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

solace.semp: MsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold

The thresholds for the request queue depth event, relative to maxRequestQueueDepth.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

solace.semp: MsgVpnDistributedCacheClusterEventRequestRateThreshold

The thresholds for the cache request message rate event, in messages per second.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25000.

solace.semp: MsgVpnDistributedCacheClusterEventResponseRateThreshold

The thresholds for the cache response message rate event, in messages per second.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80000.

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeCluster

Fields

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clusterName? string - The name of the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

homeClusterName? string - The name of the remote Home Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks

Fields

topicPrefixesUri? string - The URI of this Home Cache Cluster's collection of Topic Prefix objects.

uri? string - The URI of this Home Cache Cluster object.

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse

Fields

data? MsgVpnDistributedCacheClusterGlobalCachingHomeCluster -

links? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse

Fields

data? MsgVpnDistributedCacheClusterGlobalCachingHomeCluster[] -

links? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix

Fields

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clusterName? string - The name of the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

homeClusterName? string - The name of the remote Home Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

topicPrefix? string - A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse

Fields

data? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix[] -

links? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks

Fields

uri? string - The URI of this Topic Prefix object.

solace.semp: MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse

Fields

data? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix -

links? MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterInstance

Fields

autoStartEnabled? boolean - Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clusterName? string - The name of the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

enabled? boolean - Enable or disable the Cache Instance. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

instanceName? string - The name of the Cache Instance. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

stopOnLostMsgEnabled? boolean - Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

solace.semp: MsgVpnDistributedCacheClusterInstanceLinks

Fields

uri? string - The URI of this Cache Instance object.

solace.semp: MsgVpnDistributedCacheClusterInstanceResponse

Fields

data? MsgVpnDistributedCacheClusterInstance -

links? MsgVpnDistributedCacheClusterInstanceLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterInstancesResponse

Fields

data? MsgVpnDistributedCacheClusterInstance[] -

links? MsgVpnDistributedCacheClusterInstanceLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterLinks

Fields

globalCachingHomeClustersUri? string - The URI of this Cache Cluster's collection of Home Cache Cluster objects.

instancesUri? string - The URI of this Cache Cluster's collection of Cache Instance objects.

topicsUri? string - The URI of this Cache Cluster's collection of Topic objects.

uri? string - The URI of this Cache Cluster object.

solace.semp: MsgVpnDistributedCacheClusterResponse

Fields

data? MsgVpnDistributedCacheCluster -

links? MsgVpnDistributedCacheClusterLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClustersResponse

Fields

data? MsgVpnDistributedCacheCluster[] -

links? MsgVpnDistributedCacheClusterLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterTopic

Fields

cacheName? string - The name of the Distributed Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

clusterName? string - The name of the Cache Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

topic? string - The value of the Topic in the form a/b/c. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnDistributedCacheClusterTopicLinks

Fields

uri? string - The URI of this Topic object.

solace.semp: MsgVpnDistributedCacheClusterTopicResponse

Fields

data? MsgVpnDistributedCacheClusterTopic -

links? MsgVpnDistributedCacheClusterTopicLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheClusterTopicsResponse

Fields

data? MsgVpnDistributedCacheClusterTopic[] -

links? MsgVpnDistributedCacheClusterTopicLinks[] -

meta SempMeta -

solace.semp: MsgVpnDistributedCacheLinks

Fields

clustersUri? string - The URI of this Distributed Cache's collection of Cache Cluster objects.

uri? string - The URI of this Distributed Cache object.

solace.semp: MsgVpnDistributedCacheResponse

Fields

data? MsgVpnDistributedCache -

links? MsgVpnDistributedCacheLinks -

meta SempMeta -

solace.semp: MsgVpnDistributedCachesResponse

Fields

data? MsgVpnDistributedCache[] -

links? MsgVpnDistributedCacheLinks[] -

meta SempMeta -

solace.semp: MsgVpnDmrBridge

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteMsgVpnName? string - The remote Message VPN of the DMR Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remoteNodeName? string - The name of the node at the remote end of the DMR Bridge. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnDmrBridgeLinks

Fields

uri? string - The URI of this DMR Bridge object.

solace.semp: MsgVpnDmrBridgeResponse

Fields

data? MsgVpnDmrBridge -

links? MsgVpnDmrBridgeLinks -

meta SempMeta -

solace.semp: MsgVpnDmrBridgesResponse

Fields

data? MsgVpnDmrBridge[] -

links? MsgVpnDmrBridgeLinks[] -

meta SempMeta -

solace.semp: MsgVpnEventConnectionCountThreshold

The thresholds for the client connection count event of the Message VPN, relative to maxConnectionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventEgressFlowCountThreshold

The thresholds for the egress flow count event of the Message VPN, relative to maxEgressFlowCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventEgressMsgRateThreshold

The thresholds for the egress message rate event of the Message VPN.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4000000.

solace.semp: MsgVpnEventEndpointCountThreshold

The thresholds for the Queues and Topic Endpoints count event of the Message VPN, relative to maxEndpointCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventIngressFlowCountThreshold

The thresholds for the receive flow count event of the Message VPN, relative to maxIngressFlowCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventIngressMsgRateThreshold

The thresholds for the receive message rate event of the Message VPN.

Fields

clearValue? int - The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000000.

setValue? int - The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4000000.

solace.semp: MsgVpnEventMsgSpoolUsageThreshold

The thresholds for the message spool usage event of the Message VPN, relative to maxMsgSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventServiceAmqpConnectionCountThreshold

The thresholds for the AMQP client connection count event of the Message VPN, relative to serviceAmqpMaxConnectionCount. Available since 2.7.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventServiceMqttConnectionCountThreshold

The thresholds for the MQTT client connection count event of the Message VPN, relative to serviceMqttMaxConnectionCount. Available since 2.1.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventServiceRestIncomingConnectionCountThreshold

The thresholds for the incoming REST client connection count event of the Message VPN, relative to serviceRestIncomingMaxConnectionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventServiceSmfConnectionCountThreshold

The thresholds for the SMF client connection count event of the Message VPN, relative to serviceSmfMaxConnectionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventServiceWebConnectionCountThreshold

The thresholds for the Web Transport client connection count event of the Message VPN, relative to serviceWebMaxConnectionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventSubscriptionCountThreshold

The thresholds for the subscription count event of the Message VPN, relative to maxSubscriptionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventTransactedSessionCountThreshold

The thresholds for the transacted session count event of the Message VPN, relative to maxTransactedSessionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnEventTransactionCountThreshold

The thresholds for the transaction count event of the Message VPN, relative to maxTransactionCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnJndiConnectionFactoriesResponse

Fields

data? MsgVpnJndiConnectionFactory[] -

links? MsgVpnJndiConnectionFactoryLinks[] -

meta SempMeta -

solace.semp: MsgVpnJndiConnectionFactory

Fields

allowDuplicateClientIdEnabled? boolean - Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.3.

clientDescription? string - The description of the Client. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

clientId? string - The Client identifier (ID). If not specified, a unique value for it will be generated. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

connectionFactoryName? string - The name of the JMS Connection Factory. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

dtoReceiveOverrideEnabled? boolean - Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

dtoReceiveSubscriberLocalPriority? Signed32 - The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

dtoReceiveSubscriberNetworkPriority? Signed32 - The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

dtoSendEnabled? boolean - Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

dynamicEndpointCreateDurableEnabled? boolean - Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls "Session.createDurableSubscriber()" or "Session.createQueue()". The created endpoint respects the message time-to-live (TTL) according to the "dynamicEndpointRespectTtlEnabled" property. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

dynamicEndpointRespectTtlEnabled? boolean - Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

guaranteedReceiveAckTimeout? Signed32 - The timeout for sending the acknowledgment (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

guaranteedReceiveReconnectRetryCount? Signed32 - The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value "-1" means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1. Available since 2.14.

guaranteedReceiveReconnectRetryWait? Signed32 - The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000. Available since 2.14.

guaranteedReceiveWindowSize? Signed32 - The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

guaranteedReceiveWindowSizeAckThreshold? Signed32 - The threshold for sending the acknowledgment (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of guaranteedReceiveWindowSize. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

guaranteedSendAckTimeout? Signed32 - The timeout for receiving the acknowledgment (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2000.

guaranteedSendWindowSize? Signed32 - The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

messagingDefaultDeliveryMode? "persistent"|"non-persistent" - The default delivery mode for messages sent by the Publisher (Producer). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "persistent". The allowed values and their meaning are: <pre> "persistent" - The broker spools messages (persists in the Message Spool) as part of the send operation. "non-persistent" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation. </pre>

messagingDefaultDmqEligibleEnabled? boolean - Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

messagingDefaultElidingEligibleEnabled? boolean - Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

messagingJmsxUserIdEnabled? boolean - Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

messagingPayloadCompressionLevel? Signed32 - The level of compression to apply to the message payload, from 1 (least compression) to 9 (most compression). A value of 0 means no compression. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.42.

messagingTextInXmlPayloadEnabled? boolean - Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

transportCompressionLevel? Signed32 - The ZLIB compression level for the connection to the broker. The value "0" means no compression, and the value "-1" means the compression level is specified in the JNDI Properties file. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1.

transportConnectRetryCount? Signed32 - The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value "0" means a single attempt (no retries), and the value "-1" means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

transportConnectRetryPerHostCount? Signed32 - The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value "0" means a single attempt (no retries), and the value "-1" means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

transportConnectTimeout? Signed32 - The timeout for establishing an initial connection to the broker, in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30000.

transportDirectTransportEnabled? boolean - Enable or disable usage of Direct Transport mode. When enabled, NON-PERSISTENT messages are sent as direct messages and non-durable topic consumers and temporary queue consumers consume using direct subscriptions rather than from guaranteed endpoints. If disabled all messaging uses guaranteed transport. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

transportKeepaliveCount? Signed32 - The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

transportKeepaliveEnabled? boolean - Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

transportKeepaliveInterval? Signed32 - The interval between application-level keepalive messages, in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000.

transportMsgCallbackOnIoThreadEnabled? boolean - Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

transportOptimizeDirectEnabled? boolean - Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (Consumer). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

transportPort? Signed32 - The connection port number on the broker for SMF clients. The value "-1" means the port is specified in the JNDI Properties file. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1.

transportReadTimeout? Signed32 - The timeout for reading a reply from the broker, in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

transportReceiveBufferSize? Signed32 - The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 65536.

transportReconnectRetryCount? Signed32 - The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value "-1" means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

transportReconnectRetryWait? Signed32 - The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000.

transportSendBufferSize? Signed32 - The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 65536.

transportTcpNoDelayEnabled? boolean - Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

xaEnabled? boolean - Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to "XAConnectionFactory", "XAQueueConnectionFactory" or "XATopicConnectionFactory". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnJndiConnectionFactoryLinks

Fields

uri? string - The URI of this JNDI Connection Factory object.

solace.semp: MsgVpnJndiConnectionFactoryResponse

Fields

data? MsgVpnJndiConnectionFactory -

links? MsgVpnJndiConnectionFactoryLinks -

meta SempMeta -

solace.semp: MsgVpnJndiQueue

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

physicalName? string - The physical name of the JMS Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

queueName? string - The JNDI name of the JMS Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnJndiQueueLinks

Fields

uri? string - The URI of this JNDI Queue object.

solace.semp: MsgVpnJndiQueueResponse

Fields

data? MsgVpnJndiQueue -

links? MsgVpnJndiQueueLinks -

meta SempMeta -

solace.semp: MsgVpnJndiQueuesResponse

Fields

data? MsgVpnJndiQueue[] -

links? MsgVpnJndiQueueLinks[] -

meta SempMeta -

solace.semp: MsgVpnJndiTopic

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

physicalName? string - The physical name of the JMS Topic. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

topicName? string - The JNDI name of the JMS Topic. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnJndiTopicLinks

Fields

uri? string - The URI of this JNDI Topic object.

solace.semp: MsgVpnJndiTopicResponse

Fields

data? MsgVpnJndiTopic -

links? MsgVpnJndiTopicLinks -

meta SempMeta -

solace.semp: MsgVpnJndiTopicsResponse

Fields

data? MsgVpnJndiTopic[] -

links? MsgVpnJndiTopicLinks[] -

meta SempMeta -

solace.semp: MsgVpnKafkaReceiver

Fields

authenticationAwsMskIamAccessKeyId? string - The AWS Access Key identifier, typically beginning "AKIA...". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamRegion? string - The AWS Region code, such as "us-east-1". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamSecretAccessKey? string - The AWS Access Key secret. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsExternalId? string - The External ID is a unique identifier that might be required when assuming a role. Used with STS only; optional. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsRoleArn? string - The Amazon Resource Name (ARN) of the role to assume, typically beginning "arn:aws:iam::...". Used with STS only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsRoleSessionName? string - An identifier for the assumed role's session. Used with STS only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationBasicPassword? string - The password for the Username. To be used when authenticationScheme is "basic". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationBasicUsername? string - The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authenticationScheme is "basic". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationClientCertContent? string - The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. To be used when authenticationScheme is "client-certificate". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an ssl.client.auth setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka Broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

authenticationClientCertPassword? string - The password for the client certificate. To be used when authenticationScheme is "client-certificate". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an ssl.client.auth setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka Broker. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

authenticationKerberosKeytabContent? string - The base64-encoded content of this User Principal's keytab. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationKerberosKeytabFileName? string - The name of this User Principal's keytab file. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationKerberosServiceName? string - The Kerberos service name of the remote Kafka broker, not including /hostname@REALM. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.40.

authenticationKerberosUserPrincipalName? string - The Kerberos user principal name of the Kafka Receiver. This must include the @<REALM> suffix. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationOauthClientId? string - The OAuth client ID. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientScope? string - The OAuth scope. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientSecret? string - The OAuth client secret. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientTokenEndpoint? string - The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationScheme? "none"|"aws-msk-iam"|"aws-msk-iam-sts"|"basic"|"scram"|"client-certificate"|"kerberos"|"oauth-client" - The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports. "aws-msk-iam" - Amazon Web Services (AWS) Managed Streaming for Kafka (MSK) Identity and Access Management (IAM) Authentication. Requires encryption. "aws-msk-iam-sts" - AWS MSK IAM with Security Token Service (STS) Authentication. Requires encryption. "basic" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports. "kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports. </pre>

authenticationScramHash? "sha-256"|"sha-512" - The hash used for SCRAM authentication. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "sha-512". The allowed values and their meaning are: <pre> "sha-256" - SHA-2 256 bits. "sha-512" - SHA-2 512 bits. </pre>

authenticationScramPassword? string - The password for the Username. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationScramUsername? string - The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

batchDelay? Signed32 - Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. This corresponds to the Kafka consumer API fetch.max.wait.ms configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 500.

batchMaxSize? Signed32 - Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. This corresponds to the Kafka consumer API fetch.min.bytes configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

bootstrapAddressList? string - Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. This corresponds to the Kafka consumer API bootstrap.servers configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

enabled? boolean - Enable or disable the Kafka Receiver. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

groupId? string - The id of the Kafka consumer group for the Receiver. This corresponds to the Kafka consumer API group.id configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

groupKeepaliveInterval? Signed32 - The time (in ms) between sending keepalives to the group. This corresponds to the Kafka consumer API heartbeat.interval.ms configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000.

groupKeepaliveTimeout? Signed32 - The time (in ms) until unresponsive group members are removed, triggering a partition rebalance across other members of the group. This corresponds to the Kafka consumer API session.timeout.ms configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 45000.

groupMembershipType? "dynamic"|"static" - The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within groupKeepaliveTimeout) without prompting a group rebalance. This corresponds to the Kafka consumer API group.instance.id configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "dynamic". The allowed values and their meaning are: <pre> "dynamic" - Dynamic Membership. "static" - Static Membership. </pre>

groupPartitionSchemeList? string - The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager ("range", "roundrobin") and Cooperative ("cooperative-sticky") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. This corresponds to the Kafka consumer API partition.assignment.strategy configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "range,roundrobin".

kafkaReceiverName? string - The name of the Kafka Receiver. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

metadataTopicExcludeList? string - A comma-separated list of POSIX.2 regular expressions. Commas within each regular expression must be escaped as double commas. Any matching topic names will be ignored in broker metadata. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

metadataTopicRefreshInterval? Signed32 - The time between refreshes of topic metadata from the Kafka Cluster. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30000.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

transportTlsEnabled? boolean - Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnKafkaReceiverLinks

Fields

topicBindingsUri? string - The URI of this Kafka Receiver's collection of Topic Binding objects.

uri? string - The URI of this Kafka Receiver object.

solace.semp: MsgVpnKafkaReceiverResponse

Fields

data? MsgVpnKafkaReceiver -

links? MsgVpnKafkaReceiverLinks -

meta SempMeta -

solace.semp: MsgVpnKafkaReceiversResponse

Fields

data? MsgVpnKafkaReceiver[] -

links? MsgVpnKafkaReceiverLinks[] -

meta SempMeta -

solace.semp: MsgVpnKafkaReceiverTopicBinding

Fields

enabled? boolean - Enable or disable this topic binding of the Kafka Receiver. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

initialOffset? "beginning"|"end" - The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. This corresponds to the Kafka consumer API auto.offset.reset configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "end". The allowed values and their meaning are: <pre> "beginning" - Start with the earliest offset available. "end" - Start with new offsets only. </pre>

kafkaReceiverName? string - The name of the Kafka Receiver. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

localKey? string - The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic. If empty, no key is included for each message as it is published into Solace. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

localTopic? string - The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic. If empty, the Topic Binding will not be operational. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

topicName? string - The name of the Topic or a POSIX.2 regular expression starting with '^'. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnKafkaReceiverTopicBindingLinks

Fields

uri? string - The URI of this Topic Binding object.

solace.semp: MsgVpnKafkaReceiverTopicBindingResponse

Fields

data? MsgVpnKafkaReceiverTopicBinding -

links? MsgVpnKafkaReceiverTopicBindingLinks -

meta SempMeta -

solace.semp: MsgVpnKafkaReceiverTopicBindingsResponse

Fields

data? MsgVpnKafkaReceiverTopicBinding[] -

links? MsgVpnKafkaReceiverTopicBindingLinks[] -

meta SempMeta -

solace.semp: MsgVpnKafkaSender

Fields

authenticationAwsMskIamAccessKeyId? string - The AWS Access Key identifier, typically beginning "AKIA...". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamRegion? string - The AWS Region code, such as "us-east-1". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamSecretAccessKey? string - The AWS Access Key secret. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsExternalId? string - The External ID is a unique identifier that might be required when assuming a role. Used with STS only; optional. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsRoleArn? string - The Amazon Resource Name (ARN) of the role to assume, typically beginning "arn:aws:iam::...". Used with STS only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationAwsMskIamStsRoleSessionName? string - An identifier for the assumed role's session. Used with STS only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.46.

authenticationBasicPassword? string - The password for the Username. To be used when authenticationScheme is "basic". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationBasicUsername? string - The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is "basic". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationClientCertContent? string - The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. To be used when authenticationScheme is "client-certificate". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an ssl.client.auth setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka Broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

authenticationClientCertPassword? string - The password for the client certificate. To be used when authenticationScheme is "client-certificate". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an ssl.client.auth setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka Broker. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "".

authenticationKerberosKeytabContent? string - The base64-encoded content of this User Principal's keytab. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationKerberosKeytabFileName? string - The name of this User Principal's keytab file. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationKerberosServiceName? string - The Kerberos service name of the remote Kafka broker, not including /hostname@REALM. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.40.

authenticationKerberosUserPrincipalName? string - The Kerberos user principal name of the Kafka Sender. This must include the @<REALM> suffix. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.40.

authenticationOauthClientId? string - The OAuth client ID. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientScope? string - The OAuth scope. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientSecret? string - The OAuth client secret. To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationOauthClientTokenEndpoint? string - The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authenticationScheme is "oauth-client". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationScheme? "none"|"aws-msk-iam"|"aws-msk-iam-sts"|"basic"|"scram"|"client-certificate"|"kerberos"|"oauth-client" - The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports. "aws-msk-iam" - Amazon Web Services (AWS) Managed Streaming for Kafka (MSK) Identity and Access Management (IAM) Authentication. Requires encryption. "aws-msk-iam-sts" - AWS MSK IAM with Security Token Service (STS) Authentication. Requires encryption. "basic" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports. "kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports. </pre>

authenticationScramHash? "sha-256"|"sha-512" - The hash used for SCRAM authentication. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "sha-512". The allowed values and their meaning are: <pre> "sha-256" - SHA-2 256 bits. "sha-512" - SHA-2 512 bits. </pre>

authenticationScramPassword? string - The password for the Username. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationScramUsername? string - The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is "scram". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

batchDelay? Signed32 - Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. This corresponds to the Kafka producer API linger.ms configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5.

batchMaxMsgCount? Signed32 - Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

batchMaxSize? Signed32 - Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. This corresponds to the Kafka producer API batch.size configuration setting, and should not exceed either the Kafka broker message.max.bytes configuration setting, or the per-Topic override of max.message.bytes. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000000.

bootstrapAddressList? string - Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. This corresponds to the Kafka producer API bootstrap.servers configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

enabled? boolean - Enable or disable the Kafka Sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

idempotenceEnabled? boolean - Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. When idempotence is enabled the Queue Bindings of the Kafka Sender must have ackMode of "all" to be operational. This corresponds to the Kafka producer API enable.idempotence configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

kafkaSenderName? string - The name of the Kafka Sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

transportCompressionEnabled? boolean - Enable or disable compression for the Kafka Sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

transportCompressionLevel? Signed32 - Compression level. The valid range is dependent on the compression type. This corresponds to the Kafka producer API compression.level configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1.

transportCompressionType? "gzip"|"snappy"|"lz4"|"zstd" - Compression type. Only relevant if compression is enabled. This corresponds to the Kafka producer API compression.type configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "gzip". The allowed values and their meaning are: <pre> "gzip" - GZIP Compression. "snappy" - Snappy Compression. "lz4" - LZ4 Compression. "zstd" - Zstandard Compression. </pre>

transportTlsEnabled? boolean - Enable or disable encryption (TLS) for the Kafka Sender. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnKafkaSenderLinks

Fields

queueBindingsUri? string - The URI of this Kafka Sender's collection of Queue Binding objects.

uri? string - The URI of this Kafka Sender object.

solace.semp: MsgVpnKafkaSenderQueueBinding

Fields

ackMode? "none"|"one"|"all" - The number of acks required from the remote Kafka Broker. When "none" messages are delivered at-most-once. When "one" or "all" messages are delivered at-least-once but may be reordered. This must be configured as "all" for an idempotent Kafka Sender, otherwise the Queue Binding will be operationally down. This corresponds to the Kafka producer API acks configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "all". The allowed values and their meaning are: <pre> "none" - No Acks. "one" - Leader Ack Only. "all" - All Replica Acks. </pre>

enabled? boolean - Enable or disable this queue binding of the Kafka Sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

kafkaSenderName? string - The name of the Kafka Sender. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

partitionConsistentHash? "crc"|"murmur2"|"fnv1a" - The hash algorithm to use for consistent partition selection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "crc". The allowed values and their meaning are: <pre> "crc" - CRC Hash. "murmur2" - Murmer2 Hash. "fnv1a" - Fowler-Noll-Vo 1a Hash. </pre>

partitionExplicitNumber? int - The partition number to use for explicit partition selection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

partitionRandomFallbackEnabled? boolean - Enable or disable fallback to the random partition selection scheme when the consistent partition scheme is being used but no partition key is available for the message. When enabled a random partition will be selected for each unkeyed messages, otherwise some partition will be selected for groups of unkeyed messages. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

partitionScheme? "consistent"|"explicit"|"random" - The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. This corresponds to the Kafka producer API partitioner.class configuration setting. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "consistent". The allowed values and their meaning are: <pre> "consistent" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number. "explicit" - Select an explicit partition independent of key value. "random" - Select a random partition independent of key value. </pre>

queueName? string - The name of the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

remoteKey? string - The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue. If empty, no key is included for each message as it is published into Kafka. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remoteTopic? string - The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to. If empty, the Queue Binding will not be operational. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

solace.semp: MsgVpnKafkaSenderQueueBindingLinks

Fields

uri? string - The URI of this Queue Binding object.

solace.semp: MsgVpnKafkaSenderQueueBindingResponse

Fields

data? MsgVpnKafkaSenderQueueBinding -

links? MsgVpnKafkaSenderQueueBindingLinks -

meta SempMeta -

solace.semp: MsgVpnKafkaSenderQueueBindingsResponse

Fields

data? MsgVpnKafkaSenderQueueBinding[] -

links? MsgVpnKafkaSenderQueueBindingLinks[] -

meta SempMeta -

solace.semp: MsgVpnKafkaSenderResponse

Fields

data? MsgVpnKafkaSender -

links? MsgVpnKafkaSenderLinks -

meta SempMeta -

solace.semp: MsgVpnKafkaSendersResponse

Fields

data? MsgVpnKafkaSender[] -

links? MsgVpnKafkaSenderLinks[] -

meta SempMeta -

solace.semp: MsgVpnLinks

Fields

aclProfilesUri? string - The URI of this Message VPN's collection of ACL Profile objects.

authenticationKerberosRealmsUri? string - The URI of this Message VPN's collection of Realm objects. Available since 2.40.

authenticationOauthProfilesUri? string - The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25.

authenticationOauthProvidersUri? string - The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles.

authorizationGroupsUri? string - The URI of this Message VPN's collection of Authorization Group objects.

bridgesUri? string - The URI of this Message VPN's collection of Bridge objects.

certMatchingRulesUri? string - The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27.

clientProfilesUri? string - The URI of this Message VPN's collection of Client Profile objects.

clientUsernamesUri? string - The URI of this Message VPN's collection of Client Username objects.

distributedCachesUri? string - The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11.

dmrBridgesUri? string - The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11.

jndiConnectionFactoriesUri? string - The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.2.

jndiQueuesUri? string - The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.2.

jndiTopicsUri? string - The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.2.

kafkaReceiversUri? string - The URI of this Message VPN's collection of Kafka Receiver objects. Available since 2.36.

kafkaSendersUri? string - The URI of this Message VPN's collection of Kafka Sender objects. Available since 2.36.

mqttRetainCachesUri? string - The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11.

mqttSessionsUri? string - The URI of this Message VPN's collection of MQTT Session objects. Available since 2.1.

proxiesUri? string - The URI of this Message VPN's collection of Proxy objects. Available since 2.36.

queueTemplatesUri? string - The URI of this Message VPN's collection of Queue Template objects. Available since 2.14.

queuesUri? string - The URI of this Message VPN's collection of Queue objects.

replayLogsUri? string - The URI of this Message VPN's collection of Replay Log objects. Available since 2.10.

replicatedTopicsUri? string - The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.1.

restDeliveryPointsUri? string - The URI of this Message VPN's collection of REST Delivery Point objects.

sequencedTopicsUri? string - The URI of this Message VPN's collection of Sequenced Topic objects. Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.

telemetryProfilesUri? string - The URI of this Message VPN's collection of Telemetry Profile objects. Available since 2.31.

topicEndpointTemplatesUri? string - The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14.

topicEndpointsUri? string - The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.1.

uri? string - The URI of this Message VPN object.

solace.semp: MsgVpnMqttRetainCache

Fields

cacheName? string - The name of the MQTT Retain Cache. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

enabled? boolean - Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgLifetime? int - The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnMqttRetainCacheLinks

Fields

uri? string - The URI of this MQTT Retain Cache object.

solace.semp: MsgVpnMqttRetainCacheResponse

Fields

data? MsgVpnMqttRetainCache -

links? MsgVpnMqttRetainCacheLinks -

meta SempMeta -

solace.semp: MsgVpnMqttRetainCachesResponse

Fields

data? MsgVpnMqttRetainCache[] -

links? MsgVpnMqttRetainCacheLinks[] -

meta SempMeta -

solace.semp: MsgVpnMqttSession

Fields

enabled? boolean - Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

mqttSessionClientId? string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

mqttSessionVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the MQTT Session. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The MQTT Session belongs to the primary virtual router. "backup" - The MQTT Session belongs to the backup virtual router. "auto" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre>

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

owner? string - The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

queueConsumerAckPropagationEnabled? boolean - Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.14.

queueDeadMsgQueue? string - The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE". Available since 2.14.

queueEventBindCountThreshold? MsgVpnMqttSessionQueueEventBindCountThreshold - Thresholds for the high number of the MQTT Session Queue Consumers Event, relative to queueMaxBindCount. Available since 2.14.

queueEventMsgSpoolUsageThreshold? MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold - The threshold for the Message Spool usage event of the MQTT Session Queue, relative to queueMaxMsgSpoolUsage. Available since 2.14.

queueEventRejectLowPriorityMsgLimitThreshold? MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold - The threshold for the maximum allowed number of any priority messages queued in the MQTT Session Queue, relative to queueRejectLowPriorityMsgLimit. Available since 2.14.

queueMaxBindCount? int - The maximum number of consumer flows that can bind to the MQTT Session Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000. Available since 2.14.

queueMaxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000. Available since 2.14.

queueMaxMsgSize? Signed32 - The maximum message size allowed in the MQTT Session Queue, in bytes (B). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000. Available since 2.14.

queueMaxMsgSpoolUsage? int - The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000. Available since 2.14.

queueMaxRedeliveryCount? int - The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.14.

queueMaxTtl? int - The maximum time in seconds a message can stay in the MQTT Session Queue when queueRespectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the queueMaxTtl configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.14.

queueRejectLowPriorityMsgEnabled? boolean - Enable or disable the checking of low priority messages against the queueRejectLowPriorityMsgLimit. This may only be enabled if queueRejectMsgToSenderOnDiscardBehavior does not have a value of "never". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.14.

queueRejectLowPriorityMsgLimit? int - The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.14.

queueRejectMsgToSenderOnDiscardBehavior? "never"|"when-queue-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as queueRejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-queue-enabled". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-queue-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre> Available since 2.14.

queueRespectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the MQTT Session Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.49.

queueRespectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.14.

solace.semp: MsgVpnMqttSessionLinks

Fields

subscriptionsUri? string - The URI of this MQTT Session's collection of Subscription objects.

uri? string - The URI of this MQTT Session object.

solace.semp: MsgVpnMqttSessionQueueEventBindCountThreshold

Thresholds for the high number of the MQTT Session Queue Consumers Event, relative to queueMaxBindCount. Available since 2.14.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold

The threshold for the Message Spool usage event of the MQTT Session Queue, relative to queueMaxMsgSpoolUsage. Available since 2.14.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold

The threshold for the maximum allowed number of any priority messages queued in the MQTT Session Queue, relative to queueRejectLowPriorityMsgLimit. Available since 2.14.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnMqttSessionResponse

Fields

data? MsgVpnMqttSession -

links? MsgVpnMqttSessionLinks -

meta SempMeta -

solace.semp: MsgVpnMqttSessionsResponse

Fields

data? MsgVpnMqttSession[] -

links? MsgVpnMqttSessionLinks[] -

meta SempMeta -

solace.semp: MsgVpnMqttSessionSubscription

Fields

mqttSessionClientId? string - The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

mqttSessionVirtualRouter? "primary"|"backup"|"auto" - The virtual router of the MQTT Session. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "primary" - The MQTT Session belongs to the primary virtual router. "backup" - The MQTT Session belongs to the backup virtual router. "auto" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre>

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscriptionQos? int - The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

subscriptionTopic? string - The MQTT subscription topic. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnMqttSessionSubscriptionLinks

Fields

uri? string - The URI of this Subscription object.

solace.semp: MsgVpnMqttSessionSubscriptionResponse

Fields

data? MsgVpnMqttSessionSubscription -

links? MsgVpnMqttSessionSubscriptionLinks -

meta SempMeta -

solace.semp: MsgVpnMqttSessionSubscriptionsResponse

Fields

data? MsgVpnMqttSessionSubscription[] -

links? MsgVpnMqttSessionSubscriptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnProxiesResponse

Fields

data? MsgVpnProxy[] -

links? MsgVpnProxyLinks[] -

meta SempMeta -

solace.semp: MsgVpnProxy

Fields

authenticationBasicPassword? string - The password to use with basic authentication. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationBasicUsername? string - The username to use with basic authentication. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationScheme? "none"|"basic" - The authentication scheme used to connect to the proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - No authentication. "basic" - Username/password authentication. </pre>

enabled? boolean - Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

host? string - The IP address or host name of the proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

port? Signed32 - The port to connect to on the proxy host. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

proxyName? string - The name of the proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

proxyType? "direct"|"http" - The type of proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "direct". The allowed values and their meaning are: <pre> "direct" - Direct connection (no proxy). "http" - HTTP proxy. </pre>

solace.semp: MsgVpnProxyLinks

Fields

uri? string - The URI of this Proxy object.

solace.semp: MsgVpnProxyResponse

Fields

data? MsgVpnProxy -

links? MsgVpnProxyLinks -

meta SempMeta -

solace.semp: MsgVpnQueue

Fields

accessType? "exclusive"|"non-exclusive" - The access type for delivering messages to consumer flows bound to the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are: <pre> "exclusive" - Exclusive delivery of messages to the first bound consumer flow. "non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. </pre>

consumerAckPropagationEnabled? boolean - Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

deadMsgQueue? string - The name of the Dead Message Queue (DMQ) used by the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE". Available since 2.2.

deliveryCountEnabled? boolean - Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.19.

deliveryDelay? int - The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

egressEnabled? boolean - Enable or disable the transmission of messages from the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventBindCountThreshold? MsgVpnQueueEventBindCountThreshold - The thresholds for the Queue consumer flows event, relative to maxBindCount.

eventMsgSpoolUsageThreshold? MsgVpnQueueEventMsgSpoolUsageThreshold - The thresholds for the message spool usage event of the Queue, relative to maxMsgSpoolUsage.

eventRejectLowPriorityMsgLimitThreshold? MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold - The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to rejectLowPriorityMsgLimit.

ingressEnabled? boolean - Enable or disable the reception of messages to the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

maxBindCount? int - The maximum number of consumer flows that can bind to the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow for the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

maxMsgSize? Signed32 - The maximum message size allowed in the Queue, in bytes (B). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

maxMsgSpoolUsage? int - The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

maxRedeliveryCount? int - The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

maxTtl? int - The maximum time in seconds a message can stay in the Queue when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

owner? string - The Client Username that owns the Queue and has permission equivalent to "delete". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

partitionCount? Signed32 - The count of partitions of the queue. Only relevant for queues with an access type of non-exclusive. When zero, bound clients receive messages round-robin. Otherwise, bound clients receive messages from individually assigned partitions. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.35.

partitionRebalanceDelay? int - The delay (in seconds) before a partition rebalance is started once needed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5. Available since 2.35.

partitionRebalanceMaxHandoffTime? int - The maximum time (in seconds) to wait before handing off a partition while rebalancing. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3. Available since 2.35.

permission? "no-access"|"read-only"|"consume"|"modify-topic"|"delete" - The permission level for all consumers of the Queue, excluding the owner. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are: <pre> "no-access" - Disallows all access. "read-only" - Read-only access to the messages. "consume" - Consume (read and remove) messages. "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre>

queueName? string - The name of the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

redeliveryDelayEnabled? boolean - Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.33.

redeliveryDelayInitialInterval? Signed32 - The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000. Available since 2.33.

redeliveryDelayMaxInterval? Signed32 - The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 64000. Available since 2.33.

redeliveryDelayMultiplier? Signed32 - The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 200. Available since 2.33.

redeliveryEnabled? boolean - Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

rejectLowPriorityMsgEnabled? boolean - Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

rejectLowPriorityMsgLimit? int - The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

rejectMsgToSenderOnDiscardBehavior? "never"|"when-queue-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-queue-enabled". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-queue-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre> Available since 2.1.

respectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.49.

respectMsgPriorityEnabled? boolean - Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). Regardless of this setting, message priority is not respected when browsing the queue, when the queue is used by a bridge, or if the queue is partitioned. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.8.

respectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnQueueEventBindCountThreshold

The thresholds for the Queue consumer flows event, relative to maxBindCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueEventMsgSpoolUsageThreshold

The thresholds for the message spool usage event of the Queue, relative to maxMsgSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold

The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to rejectLowPriorityMsgLimit.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueLinks

Fields

subscriptionsUri? string - The URI of this Queue's collection of Queue Subscription objects.

uri? string - The URI of this Queue object.

solace.semp: MsgVpnQueueResponse

Fields

data? MsgVpnQueue -

links? MsgVpnQueueLinks -

meta SempMeta -

solace.semp: MsgVpnQueuesResponse

Fields

data? MsgVpnQueue[] -

links? MsgVpnQueueLinks[] -

meta SempMeta -

solace.semp: MsgVpnQueueSubscription

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

queueName? string - The name of the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscriptionTopic? string - The topic of the Subscription. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnQueueSubscriptionLinks

Fields

uri? string - The URI of this Queue Subscription object.

solace.semp: MsgVpnQueueSubscriptionResponse

Fields

data? MsgVpnQueueSubscription -

links? MsgVpnQueueSubscriptionLinks -

meta SempMeta -

solace.semp: MsgVpnQueueSubscriptionsResponse

Fields

data? MsgVpnQueueSubscription[] -

links? MsgVpnQueueSubscriptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnQueueTemplate

Fields

accessType? "exclusive"|"non-exclusive" - The access type for delivering messages to consumer flows. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are: <pre> "exclusive" - Exclusive delivery of messages to the first bound consumer flow. "non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. </pre>

consumerAckPropagationEnabled? boolean - Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

deadMsgQueue? string - The name of the Dead Message Queue (DMQ). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE".

deliveryDelay? int - The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

durabilityOverride? "none"|"non-durable" - Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - The durability of the endpoint will be as requested on create. "non-durable" - The durability of the created queue will be non-durable, regardless of what was requested. </pre>

eventBindCountThreshold? MsgVpnQueueTemplateEventBindCountThreshold - The thresholds for the Queue consumer flows event, relative to maxBindCount.

eventMsgSpoolUsageThreshold? MsgVpnQueueTemplateEventMsgSpoolUsageThreshold - The thresholds for the message spool usage event of the Queue, relative to maxMsgSpoolUsage.

eventRejectLowPriorityMsgLimitThreshold? MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold - The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to rejectLowPriorityMsgLimit.

maxBindCount? int - The maximum number of consumer flows that can bind. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

maxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

maxMsgSize? Signed32 - The maximum message size allowed, in bytes (B). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

maxMsgSpoolUsage? int - The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

maxRedeliveryCount? int - The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

maxTtl? int - The maximum time in seconds a message can stay in a Queue when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

permission? "no-access"|"read-only"|"consume"|"modify-topic"|"delete" - The permission level for all consumers, excluding the owner. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are: <pre> "no-access" - Disallows all access. "read-only" - Read-only access to the messages. "consume" - Consume (read and remove) messages. "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre>

queueNameFilter? string - A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

queueTemplateName? string - The name of the Queue Template. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

redeliveryDelayEnabled? boolean - Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.33.

redeliveryDelayInitialInterval? Signed32 - The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000. Available since 2.33.

redeliveryDelayMaxInterval? Signed32 - The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 64000. Available since 2.33.

redeliveryDelayMultiplier? Signed32 - The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 200. Available since 2.33.

redeliveryEnabled? boolean - Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

rejectLowPriorityMsgEnabled? boolean - Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

rejectLowPriorityMsgLimit? int - The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

rejectMsgToSenderOnDiscardBehavior? "never"|"when-queue-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-queue-enabled". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-queue-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre>

respectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.49.

respectMsgPriorityEnabled? boolean - Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

respectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnQueueTemplateEventBindCountThreshold

The thresholds for the Queue consumer flows event, relative to maxBindCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueTemplateEventMsgSpoolUsageThreshold

The thresholds for the message spool usage event of the Queue, relative to maxMsgSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold

The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to rejectLowPriorityMsgLimit.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnQueueTemplateLinks

Fields

uri? string - The URI of this Queue Template object.

solace.semp: MsgVpnQueueTemplateResponse

Fields

data? MsgVpnQueueTemplate -

links? MsgVpnQueueTemplateLinks -

meta SempMeta -

solace.semp: MsgVpnQueueTemplatesResponse

Fields

data? MsgVpnQueueTemplate[] -

links? MsgVpnQueueTemplateLinks[] -

meta SempMeta -

solace.semp: MsgVpnReplayLog

Fields

egressEnabled? boolean - Enable or disable the transmission of messages from the Replay Log. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager or vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

ingressEnabled? boolean - Enable or disable the reception of messages to the Replay Log. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager or vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

maxSpoolUsage? int - The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager or vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

replayLogName? string - The name of the Replay Log. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

topicFilterEnabled? boolean - Enable or disable topic filtering for the Replay Log. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "global/mesh-manager or vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.27.

solace.semp: MsgVpnReplayLogLinks

Fields

topicFilterSubscriptionsUri? string - The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27.

uri? string - The URI of this Replay Log object.

solace.semp: MsgVpnReplayLogResponse

Fields

data? MsgVpnReplayLog -

links? MsgVpnReplayLogLinks -

meta SempMeta -

solace.semp: MsgVpnReplayLogsResponse

Fields

data? MsgVpnReplayLog[] -

links? MsgVpnReplayLogLinks[] -

meta SempMeta -

solace.semp: MsgVpnReplayLogTopicFilterSubscription

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

replayLogName? string - The name of the Replay Log. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

topicFilterSubscription? string - The topic of the Subscription. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnReplayLogTopicFilterSubscriptionLinks

Fields

uri? string - The URI of this Topic Filter Subscription object.

solace.semp: MsgVpnReplayLogTopicFilterSubscriptionResponse

Fields

data? MsgVpnReplayLogTopicFilterSubscription -

links? MsgVpnReplayLogTopicFilterSubscriptionLinks -

meta SempMeta -

solace.semp: MsgVpnReplayLogTopicFilterSubscriptionsResponse

Fields

data? MsgVpnReplayLogTopicFilterSubscription[] -

links? MsgVpnReplayLogTopicFilterSubscriptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnReplicatedTopic

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

replicatedTopic? string - The topic for applying replication. Published messages matching this topic will be replicated to the standby site. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

replicationMode? "sync"|"async" - The replication mode for the Replicated Topic. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "async". The allowed values and their meaning are: <pre> "sync" - Messages are acknowledged when replicated (spooled remotely). "async" - Messages are acknowledged when pending replication (spooled locally). </pre>

solace.semp: MsgVpnReplicatedTopicLinks

Fields

uri? string - The URI of this Replicated Topic object.

solace.semp: MsgVpnReplicatedTopicResponse

Fields

data? MsgVpnReplicatedTopic -

links? MsgVpnReplicatedTopicLinks -

meta SempMeta -

solace.semp: MsgVpnReplicatedTopicsResponse

Fields

data? MsgVpnReplicatedTopic[] -

links? MsgVpnReplicatedTopicLinks[] -

meta SempMeta -

solace.semp: MsgVpnResponse

Fields

data? MsgVpn -

links? MsgVpnLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPoint

Fields

clientProfileName? string - The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

enabled? boolean - Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

'service? string - The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

vendor? string - The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

solace.semp: MsgVpnRestDeliveryPointLinks

Fields

queueBindingsUri? string - The URI of this REST Delivery Point's collection of Queue Binding objects.

restConsumersUri? string - The URI of this REST Delivery Point's collection of REST Consumer objects.

uri? string - The URI of this REST Delivery Point object.

solace.semp: MsgVpnRestDeliveryPointQueueBinding

Fields

gatewayReplaceTargetAuthorityEnabled? boolean - Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.6.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

postRequestTarget? string - The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a "/" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

queueBindingName? string - The name of a queue in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

requestTargetEvaluation? "none"|"substitution-expressions" - The type of evaluation to perform on the request target. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - Do not evaluate substitution expressions on the request target. "substitution-expressions" - Evaluate substitution expressions on the request target. </pre> Available since 2.23.

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnRestDeliveryPointQueueBindingLinks

Fields

protectedRequestHeadersUri? string - The URI of this Queue Binding's collection of Protected Request Header objects. Available since 2.30.

requestHeadersUri? string - The URI of this Queue Binding's collection of Request Header objects. Available since 2.23.

uri? string - The URI of this Queue Binding object.

solace.semp: MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Fields

headerName? string - The name of the protected HTTP request header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

headerValue? string - The value of the protected HTTP request header. Unlike a non-protected request header, this value cannot be displayed after it is set, and does not support substitution expressions. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

queueBindingName? string - The name of a queue in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks

Fields

uri? string - The URI of this Protected Request Header object.

solace.semp: MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse

Fields

data? MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader -

links? MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse

Fields

data? MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader[] -

links? MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointQueueBindingRequestHeader

Fields

headerName? string - The name of the HTTP request header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

headerValue? string - A substitution expression for the value of the HTTP request header. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

queueBindingName? string - The name of a queue in the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks

Fields

uri? string - The URI of this Request Header object.

solace.semp: MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse

Fields

data? MsgVpnRestDeliveryPointQueueBindingRequestHeader -

links? MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse

Fields

data? MsgVpnRestDeliveryPointQueueBindingRequestHeader[] -

links? MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointQueueBindingResponse

Fields

data? MsgVpnRestDeliveryPointQueueBinding -

links? MsgVpnRestDeliveryPointQueueBindingLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointQueueBindingsResponse

Fields

data? MsgVpnRestDeliveryPointQueueBinding[] -

links? MsgVpnRestDeliveryPointQueueBindingLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointResponse

Fields

data? MsgVpnRestDeliveryPoint -

links? MsgVpnRestDeliveryPointLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumer

Fields

authenticationAwsAccessKeyId? string - The AWS access key id. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

authenticationAwsRegion? string - The AWS region id. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

authenticationAwsSecretAccessKey? string - The AWS secret access key. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

authenticationAwsService? string - The AWS service id. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.26.

authenticationClientCertContent? string - The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.9.

authenticationClientCertPassword? string - The password for the client certificate. The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is "". Available since 2.9.

authenticationHttpBasicPassword? string - The password for the username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationHttpBasicUsername? string - The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

authenticationHttpHeaderName? string - The authentication header name. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.15.

authenticationHttpHeaderValue? string - The authentication header value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.15.

authenticationOauthClientId? string - The OAuth client ID. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

authenticationOauthClientProxyName? string - The name of the proxy to use. Leave empty for no proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.42.

authenticationOauthClientScope? string - The OAuth scope. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

authenticationOauthClientSecret? string - The OAuth client secret. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

authenticationOauthClientTokenEndpoint? string - The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.19.

authenticationOauthClientTokenExpiryDefault? Signed32 - The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 900. Available since 2.30.

authenticationOauthJwtProxyName? string - The name of the proxy to use. Leave empty for no proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.42.

authenticationOauthJwtSecretKey? string - The OAuth secret key used to sign the token request JWT. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.21.

authenticationOauthJwtTokenEndpoint? string - The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.21.

authenticationOauthJwtTokenExpiryDefault? Signed32 - The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 900. Available since 2.30.

authenticationScheme? "none"|"http-basic"|"client-certificate"|"http-header"|"oauth-client"|"oauth-jwt"|"transparent"|"aws" - The authentication scheme used by the REST Consumer to login to the REST host. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication. "http-basic" - Login with a username and optional password according to HTTP Basic authentication as per RFC 2616. "client-certificate" - Login with a client TLS certificate as per RFC 5246. Client certificate authentication is only available on TLS connections. "http-header" - Login with a specified HTTP header. "oauth-client" - Login with OAuth 2.0 client credentials. "oauth-jwt" - Login with OAuth (RFC 7523 JWT Profile). "transparent" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header. "aws" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256). </pre>

enabled? boolean - Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

httpMethod? "post"|"put" - The HTTP method to use (POST or PUT). This is used only when operating in the REST service "messaging" mode and is ignored in "gateway" mode. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "post". The allowed values and their meaning are: <pre> "post" - Use the POST HTTP method. "put" - Use the PUT HTTP method. </pre> Available since 2.17.

localInterface? string - The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

maxPostWaitTime? Signed32 - The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

outgoingConnectionCount? Signed32 - The number of concurrent TCP connections open to the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

proxyName? string - The name of the proxy to use. Leave empty for no proxy. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.36.

rejectedStatusCodeList? string - Comma-separated list of HTTP status codes or status code ranges which should be processed as a "rejected" (do not retry) outcome. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.47.

remoteHost? string - The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

remotePort? int - The port associated with the host of the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 8080.

restConsumerName? string - The name of the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

retryDelay? Signed32 - The number of seconds that must pass before retrying the remote REST Consumer connection. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

tlsCipherSuiteList? string - The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection when using TLS 1.2 and lower. The value "default" implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the tlsCipherSuiteMsgBackboneDefaultList attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "default".

tlsEnabled? boolean - Enable or disable encryption (TLS) for the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

solace.semp: MsgVpnRestDeliveryPointRestConsumerLinks

Fields

oauthJwtClaimsUri? string - The URI of this REST Consumer's collection of Claim objects. Available since 2.21.

tlsTrustedCommonNamesUri? string - The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

uri? string - The URI of this REST Consumer object.

solace.semp: MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthJwtClaimName? string - The name of the additional claim. Cannot be "exp", "iat", or "jti". The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

oauthJwtClaimValue? string - The value of the additional claim, which must be a string containing a valid JSON value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restConsumerName? string - The name of the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks

Fields

uri? string - The URI of this Claim object.

solace.semp: MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim -

links? MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim[] -

links? MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumerResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumer -

links? MsgVpnRestDeliveryPointRestConsumerLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumersResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumer[] -

links? MsgVpnRestDeliveryPointRestConsumerLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

restConsumerName? string - The name of the REST Consumer. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

restDeliveryPointName? string - The name of the REST Delivery Point. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

tlsTrustedCommonName? string - The expected trusted common name of the remote certificate. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.

solace.semp: MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks

Fields

uri? string - The URI of this Trusted Common Name object.

solace.semp: MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName -

links? MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse

Fields

data? MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName[] -

links? MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks[] -

meta SempMeta -

solace.semp: MsgVpnRestDeliveryPointsResponse

Fields

data? MsgVpnRestDeliveryPoint[] -

links? MsgVpnRestDeliveryPointLinks[] -

meta SempMeta -

solace.semp: MsgVpnSequencedTopic

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.

sequencedTopic? string - Topic for applying sequence numbers. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.

solace.semp: MsgVpnSequencedTopicLinks

Fields

uri? string - The URI of this Sequenced Topic object.

solace.semp: MsgVpnSequencedTopicResponse

Fields

data? MsgVpnSequencedTopic -

links? MsgVpnSequencedTopicLinks -

meta SempMeta -

solace.semp: MsgVpnSequencedTopicsResponse

Fields

data? MsgVpnSequencedTopic[] -

links? MsgVpnSequencedTopicLinks[] -

meta SempMeta -

solace.semp: MsgVpnsResponse

Fields

data? MsgVpn[] -

links? MsgVpnLinks[] -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfile

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

queueEventBindCountThreshold? MsgVpnTelemetryProfileQueueEventBindCountThreshold - The thresholds for the Queue consumer flows event, relative to queueMaxBindCount.

queueEventMsgSpoolUsageThreshold? MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold - The thresholds for the message spool usage event of the Queue, relative to queueMaxMsgSpoolUsage.

queueMaxBindCount? int - The maximum number of consumer flows that can bind to the Queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

queueMaxMsgSpoolUsage? int - The maximum message spool usage allowed by the Queue, in megabytes (MB). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 800000.

receiverAclConnectDefaultAction? "allow"|"disallow" - The default action to take when a receiver client connects to the broker. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "disallow". The allowed values and their meaning are: <pre> "allow" - Allow client connection unless an exception is found for it. "disallow" - Disallow client connection unless an exception is found for it. </pre>

receiverEnabled? boolean - Enable or disable the ability for receiver clients to consume from the #telemetry queue. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

receiverEventConnectionCountPerClientUsernameThreshold? MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold - The thresholds for the receiver connection count event, relative to receiverMaxConnectionCountPerClientUsername.

receiverMaxConnectionCountPerClientUsername? int - The maximum number of receiver connections per Client Username. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

receiverTcpCongestionWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". The default value is 2. Deprecated since 2.48. The value is now ignored.

receiverTcpKeepaliveCount? int - The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5.

receiverTcpKeepaliveIdleTime? int - The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

receiverTcpKeepaliveInterval? int - The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

receiverTcpMaxSegmentSize? int - The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1460.

receiverTcpMaxWindowSize? int - Obsolete. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". The default value is 256. Deprecated since 2.48. The value is now ignored.

telemetryProfileName? string - The name of the Telemetry Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

traceEnabled? boolean - Enable or disable generation of all trace span data messages. When enabled, the state of configured trace filters control which messages get traced. When disabled, trace span data messages are never generated, regardless of the state of trace filters. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

traceSendSpanGenerationEnabled? boolean - Enable or disable generation of send spans. For the most complete view of broker message processing, this should be enabled. If the information provided by send spans are not needed, send spans can be disabled to reduce the performance impact of tracing. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.36.

solace.semp: MsgVpnTelemetryProfileLinks

Fields

receiverAclConnectExceptionsUri? string - The URI of this Telemetry Profile's collection of Receiver ACL Connect Exception objects.

traceFiltersUri? string - The URI of this Telemetry Profile's collection of Trace Filter objects.

uri? string - The URI of this Telemetry Profile object.

solace.semp: MsgVpnTelemetryProfileQueueEventBindCountThreshold

The thresholds for the Queue consumer flows event, relative to queueMaxBindCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold

The thresholds for the message spool usage event of the Queue, relative to queueMaxMsgSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTelemetryProfileReceiverAclConnectException

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

receiverAclConnectExceptionAddress? string - The IP address/netmask of the receiver connect exception in CIDR form. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

telemetryProfileName? string - The name of the Telemetry Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks

Fields

uri? string - The URI of this Receiver ACL Connect Exception object.

solace.semp: MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse

Fields

data? MsgVpnTelemetryProfileReceiverAclConnectException -

links? MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse

Fields

data? MsgVpnTelemetryProfileReceiverAclConnectException[] -

links? MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold

The thresholds for the receiver connection count event, relative to receiverMaxConnectionCountPerClientUsername.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTelemetryProfileResponse

Fields

data? MsgVpnTelemetryProfile -

links? MsgVpnTelemetryProfileLinks -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfilesResponse

Fields

data? MsgVpnTelemetryProfile[] -

links? MsgVpnTelemetryProfileLinks[] -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileTraceFilter

Fields

enabled? boolean - Enable or disable the trace filter. When the filter is disabled, the filter's subscriptions will not trigger a message to be traced. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

telemetryProfileName? string - The name of the Telemetry Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

traceFilterName? string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug". The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnTelemetryProfileTraceFilterLinks

Fields

subscriptionsUri? string - The URI of this Trace Filter's collection of Telemetry Trace Filter Subscription objects.

uri? string - The URI of this Trace Filter object.

solace.semp: MsgVpnTelemetryProfileTraceFilterResponse

Fields

data? MsgVpnTelemetryProfileTraceFilter -

links? MsgVpnTelemetryProfileTraceFilterLinks -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileTraceFiltersResponse

Fields

data? MsgVpnTelemetryProfileTraceFilter[] -

links? MsgVpnTelemetryProfileTraceFilterLinks[] -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileTraceFilterSubscription

Fields

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscription? string - Messages matching this subscription will follow this filter's configuration. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

subscriptionSyntax? "smf"|"mqtt" - The syntax of the trace filter subscription. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The allowed values and their meaning are: <pre> "smf" - Subscription uses SMF syntax. "mqtt" - Subscription uses MQTT syntax. </pre>

telemetryProfileName? string - The name of the Telemetry Profile. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

traceFilterName? string - A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug". The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnTelemetryProfileTraceFilterSubscriptionLinks

Fields

uri? string - The URI of this Telemetry Trace Filter Subscription object.

solace.semp: MsgVpnTelemetryProfileTraceFilterSubscriptionResponse

Fields

data? MsgVpnTelemetryProfileTraceFilterSubscription -

links? MsgVpnTelemetryProfileTraceFilterSubscriptionLinks -

meta SempMeta -

solace.semp: MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse

Fields

data? MsgVpnTelemetryProfileTraceFilterSubscription[] -

links? MsgVpnTelemetryProfileTraceFilterSubscriptionLinks[] -

meta SempMeta -

solace.semp: MsgVpnTopicEndpoint

Fields

accessType? "exclusive"|"non-exclusive" - The access type for delivering messages to consumer flows bound to the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are: <pre> "exclusive" - Exclusive delivery of messages to the first bound consumer flow. "non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion. </pre> Available since 2.4.

consumerAckPropagationEnabled? boolean - Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

deadMsgQueue? string - The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE". Available since 2.2.

deliveryCountEnabled? boolean - Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.19.

deliveryDelay? int - The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

egressEnabled? boolean - Enable or disable the transmission of messages from the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

eventBindCountThreshold? MsgVpnTopicEndpointEventBindCountThreshold - The thresholds for the Topic Endpoint consumer flows event, relative to maxBindCount. Available since 2.4.

eventRejectLowPriorityMsgLimitThreshold? MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold - The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to rejectLowPriorityMsgLimit.

eventSpoolUsageThreshold? MsgVpnTopicEndpointEventSpoolUsageThreshold - The thresholds for the message spool usage event of the Topic Endpoint, relative to maxSpoolUsage.

ingressEnabled? boolean - Enable or disable the reception of messages to the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

maxBindCount? int - The maximum number of consumer flows that can bind to the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1. Available since 2.4.

maxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

maxMsgSize? Signed32 - The maximum message size allowed in the Topic Endpoint, in bytes (B). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

maxRedeliveryCount? int - The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

maxSpoolUsage? int - The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

maxTtl? int - The maximum time in seconds a message can stay in the Topic Endpoint when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

owner? string - The Client Username that owns the Topic Endpoint and has permission equivalent to "delete". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

permission? "no-access"|"read-only"|"consume"|"modify-topic"|"delete" - The permission level for all consumers of the Topic Endpoint, excluding the owner. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are: <pre> "no-access" - Disallows all access. "read-only" - Read-only access to the messages. "consume" - Consume (read and remove) messages. "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre>

redeliveryDelayEnabled? boolean - Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.33.

redeliveryDelayInitialInterval? Signed32 - The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000. Available since 2.33.

redeliveryDelayMaxInterval? Signed32 - The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 64000. Available since 2.33.

redeliveryDelayMultiplier? Signed32 - The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 200. Available since 2.33.

redeliveryEnabled? boolean - Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

rejectLowPriorityMsgEnabled? boolean - Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

rejectLowPriorityMsgLimit? int - The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

rejectMsgToSenderOnDiscardBehavior? "never"|"when-topic-endpoint-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "never". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-topic-endpoint-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre>

respectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.49.

respectMsgPriorityEnabled? boolean - Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.8.

respectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

topicEndpointName? string - The name of the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnTopicEndpointEventBindCountThreshold

The thresholds for the Topic Endpoint consumer flows event, relative to maxBindCount. Available since 2.4.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold

The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to rejectLowPriorityMsgLimit.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointEventSpoolUsageThreshold

The thresholds for the message spool usage event of the Topic Endpoint, relative to maxSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointLinks

Fields

uri? string - The URI of this Topic Endpoint object.

solace.semp: MsgVpnTopicEndpointResponse

Fields

data? MsgVpnTopicEndpoint -

links? MsgVpnTopicEndpointLinks -

meta SempMeta -

solace.semp: MsgVpnTopicEndpointsResponse

Fields

data? MsgVpnTopicEndpoint[] -

links? MsgVpnTopicEndpointLinks[] -

meta SempMeta -

solace.semp: MsgVpnTopicEndpointTemplate

Fields

accessType? "exclusive"|"non-exclusive" - The access type for delivering messages to consumer flows. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are: <pre> "exclusive" - Exclusive delivery of messages to the first bound consumer flow. "non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion. </pre>

consumerAckPropagationEnabled? boolean - Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

deadMsgQueue? string - The name of the Dead Message Queue (DMQ). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE".

deliveryDelay? int - The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

eventBindCountThreshold? MsgVpnTopicEndpointTemplateEventBindCountThreshold - The thresholds for the Topic Endpoint consumer flows event, relative to maxBindCount.

eventMsgSpoolUsageThreshold? MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold - The thresholds for the message spool usage event of the Topic Endpoint, relative to maxSpoolUsage.

eventRejectLowPriorityMsgLimitThreshold? MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold - The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to rejectLowPriorityMsgLimit.

maxBindCount? int - The maximum number of consumer flows that can bind. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

maxDeliveredUnackedMsgsPerFlow? int - The maximum number of messages delivered but not acknowledged per flow. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

maxMsgSize? Signed32 - The maximum message size allowed, in bytes (B). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

maxMsgSpoolUsage? int - The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

maxRedeliveryCount? int - The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

maxTtl? int - The maximum time in seconds a message can stay in the Topic Endpoint when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

msgVpnName? string - The name of the Message VPN. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

permission? "no-access"|"read-only"|"consume"|"modify-topic"|"delete" - The permission level for all consumers, excluding the owner. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are: <pre> "no-access" - Disallows all access. "read-only" - Read-only access to the messages. "consume" - Consume (read and remove) messages. "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre>

redeliveryDelayEnabled? boolean - Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.33.

redeliveryDelayInitialInterval? Signed32 - The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000. Available since 2.33.

redeliveryDelayMaxInterval? Signed32 - The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 64000. Available since 2.33.

redeliveryDelayMultiplier? Signed32 - The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 200. Available since 2.33.

redeliveryEnabled? boolean - Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

rejectLowPriorityMsgEnabled? boolean - Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

rejectLowPriorityMsgLimit? int - The number of messages that are permitted before low priority messages are rejected. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

rejectMsgToSenderOnDiscardBehavior? "never"|"when-topic-endpoint-enabled"|"always" - Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "never". The allowed values and their meaning are: <pre> "never" - Silently discard messages. "when-topic-endpoint-enabled" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled. "always" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled. </pre>

respectDmqEligibleEnabled? boolean - Enable or disable the respecting of DMQ Eligible for messages in the Topic Endpoint. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.49.

respectMsgPriorityEnabled? boolean - Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

respectTtlEnabled? boolean - Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

topicEndpointNameFilter? string - A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

topicEndpointTemplateName? string - The name of the Topic Endpoint Template. The minimum access scope/level required to retrieve this attribute is "vpn/read-only".

solace.semp: MsgVpnTopicEndpointTemplateEventBindCountThreshold

The thresholds for the Topic Endpoint consumer flows event, relative to maxBindCount.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold

The thresholds for the message spool usage event of the Topic Endpoint, relative to maxSpoolUsage.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 25.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold

The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to rejectLowPriorityMsgLimit.

Fields

clearPercent? int - The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

clearValue? int - The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

setPercent? int - The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 80.

setValue? int - The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. The minimum access scope/level required to retrieve this attribute is "vpn/read-only". The minimum access scope/level required to change this attribute is "vpn/read-write". This attribute may not be returned in a GET. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.

solace.semp: MsgVpnTopicEndpointTemplateLinks

Fields

uri? string - The URI of this Topic Endpoint Template object.

solace.semp: MsgVpnTopicEndpointTemplateResponse

Fields

data? MsgVpnTopicEndpointTemplate -

links? MsgVpnTopicEndpointTemplateLinks -

meta SempMeta -

solace.semp: MsgVpnTopicEndpointTemplatesResponse

Fields

data? MsgVpnTopicEndpointTemplate[] -

links? MsgVpnTopicEndpointTemplateLinks[] -

meta SempMeta -

solace.semp: OauthProfile

Fields

accessLevelGroupsClaimName? string - The name of the groups claim. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "groups".

accessLevelGroupsClaimStringFormat? "single"|"space-delimited" - The format of the access level groups claim value when it is a string. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "single". The allowed values and their meaning are: <pre> "single" - When the claim is a string, it is interpreted as as single group. "space-delimited" - When the claim is a string, it is interpreted as a space-delimited list of groups, similar to the "scope" claim. </pre> Available since 2.32.

authenticationClientCertContent? string - The PEM formatted content for the client certificate used by the broker to login to the token and introspection endpoints. To be used when authenticationScheme is "client-certificate". The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "". Available since 2.47.

authenticationClientCertPassword? string - The password for the client certificate. To be used when authenticationScheme is "client-certificate". The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. The default value is "". Available since 2.47.

authenticationScheme? "basic"|"client-certificate" - The authentication scheme for token and introspection requests. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "basic". The allowed values and their meaning are: <pre> "basic" - Basic Authentication Scheme (via client id and client secret). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). </pre> Available since 2.47.

clientId? string - The OAuth client id. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

clientRedirectUri? string - The OAuth redirect URI. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

clientRequiredType? string - The required value for the TYP field in the ID token header. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "JWT".

clientScope? string - The OAuth scope. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "openid email".

clientSecret? string - The OAuth client secret. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

clientValidateTypeEnabled? boolean - Enable or disable verification of the TYP field in the ID token header. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

defaultGlobalAccessLevel? "none"|"read-only"|"mesh-manager"|"read-write"|"admin" - The default global access level for this OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to global data. "read-only" - User has read-only access to global data. "mesh-manager" - User has read-write access to global data required to administer this broker as a member of a mesh of brokers. "read-write" - User has read-write access to most global data. "admin" - User has read-write access to all global data. </pre>

defaultMsgVpnAccessLevel? "none"|"read-only"|"read-write" - The default message VPN access level for the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to a Message VPN. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. </pre>

displayName? string - The user friendly name for the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

enabled? boolean - Enable or disable the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

endpointAuthorization? string - The OAuth authorization endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointDiscovery? string - The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointDiscoveryRefreshInterval? Signed32 - The number of seconds between discovery endpoint requests. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 86400.

endpointIntrospection? string - The OAuth introspection endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointIntrospectionTimeout? Signed32 - The maximum time in seconds a token introspection request is allowed to take. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

endpointJwks? string - The OAuth JWKS endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointJwksRefreshInterval? Signed32 - The number of seconds between JWKS endpoint requests. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 86400.

endpointToken? string - The OAuth token endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointTokenTimeout? Signed32 - The maximum time in seconds a token request is allowed to take. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

endpointUserinfo? string - The OpenID Connect Userinfo endpoint. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

endpointUserinfoTimeout? Signed32 - The maximum time in seconds a userinfo request is allowed to take. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

interactiveEnabled? boolean - Enable or disable interactive logins via this OAuth provider. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

interactivePromptForExpiredSession? string - The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

interactivePromptForNewSession? string - The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "select_account".

issuer? string - The Issuer Identifier for the OAuth provider. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

oauthRole? "client"|"resource-server" - The OAuth role of the broker. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "client". The allowed values and their meaning are: <pre> "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. </pre>

proxyName? string - The name of the proxy to use for discovery, user info, jwks, introspection, and token requests. Leave empty for no proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "". Available since 2.41.

resourceServerParseAccessTokenEnabled? boolean - Enable or disable parsing of the access token as a JWT. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

resourceServerRequiredAudience? string - The required audience value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

resourceServerRequiredIssuer? string - The required issuer value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

resourceServerRequiredScope? string - A space-separated list of scopes that must be present in the scope claim. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

resourceServerRequiredType? string - The required TYP value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "at+jwt".

resourceServerValidateAudienceEnabled? boolean - Enable or disable verification of the audience claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

resourceServerValidateIssuerEnabled? boolean - Enable or disable verification of the issuer claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

resourceServerValidateScopeEnabled? boolean - Enable or disable verification of the scope claim in the access token or introspection response. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

resourceServerValidateTypeEnabled? boolean - Enable or disable verification of the TYP field in the access token header. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

sempEnabled? boolean - Enable or disable authentication of SEMP requests with OAuth tokens. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is true.

usernameClaimName? string - The name of the username claim. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "sub".

solace.semp: OauthProfileAccessLevelGroup

Fields

description? string - A description for the group. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

globalAccessLevel? "none"|"read-only"|"mesh-manager"|"read-write"|"admin" - The global access level for this group. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to global data. "read-only" - User has read-only access to global data. "mesh-manager" - User has read-write access to global data required to administer this broker as a member of a mesh of brokers. "read-write" - User has read-write access to most global data. "admin" - User has read-write access to all global data. </pre>

groupName? string - The name of the group. The minimum access scope/level required to retrieve this attribute is "global/read-only".

msgVpnAccessLevel? "none"|"read-only"|"read-write" - The default message VPN access level for this group. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to a Message VPN. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. </pre>

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileAccessLevelGroupLinks

Fields

msgVpnAccessLevelExceptionsUri? string - The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects.

uri? string - The URI of this Group Access Level object.

solace.semp: OauthProfileAccessLevelGroupMsgVpnAccessLevelException

Fields

accessLevel? "none"|"read-only"|"read-write" - The message VPN access level. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to a Message VPN. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. </pre>

groupName? string - The name of the group. The minimum access scope/level required to retrieve this attribute is "global/read-only".

msgVpnName? string - The name of the message VPN. The minimum access scope/level required to retrieve this attribute is "global/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks

Fields

uri? string - The URI of this Message VPN Access-Level Exception object.

solace.semp: OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse

Fields

data? OauthProfileAccessLevelGroupMsgVpnAccessLevelException -

links? OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks -

meta SempMeta -

solace.semp: OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse

Fields

data? OauthProfileAccessLevelGroupMsgVpnAccessLevelException[] -

links? OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks[] -

meta SempMeta -

solace.semp: OauthProfileAccessLevelGroupResponse

Fields

data? OauthProfileAccessLevelGroup -

links? OauthProfileAccessLevelGroupLinks -

meta SempMeta -

solace.semp: OauthProfileAccessLevelGroupsResponse

Fields

data? OauthProfileAccessLevelGroup[] -

links? OauthProfileAccessLevelGroupLinks[] -

meta SempMeta -

solace.semp: OauthProfileClientAllowedHost

Fields

allowedHost? string - An allowed value for the Host header. The minimum access scope/level required to retrieve this attribute is "global/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileClientAllowedHostLinks

Fields

uri? string - The URI of this Allowed Host Value object.

solace.semp: OauthProfileClientAllowedHostResponse

Fields

data? OauthProfileClientAllowedHost -

links? OauthProfileClientAllowedHostLinks -

meta SempMeta -

solace.semp: OauthProfileClientAllowedHostsResponse

Fields

data? OauthProfileClientAllowedHost[] -

links? OauthProfileClientAllowedHostLinks[] -

meta SempMeta -

solace.semp: OauthProfileClientAuthorizationParameter

Fields

authorizationParameterName? string - The name of the authorization parameter. The minimum access scope/level required to retrieve this attribute is "global/read-only".

authorizationParameterValue? string - The authorization parameter value. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileClientAuthorizationParameterLinks

Fields

uri? string - The URI of this Authorization Parameter object.

solace.semp: OauthProfileClientAuthorizationParameterResponse

Fields

data? OauthProfileClientAuthorizationParameter -

links? OauthProfileClientAuthorizationParameterLinks -

meta SempMeta -

solace.semp: OauthProfileClientAuthorizationParametersResponse

Fields

data? OauthProfileClientAuthorizationParameter[] -

links? OauthProfileClientAuthorizationParameterLinks[] -

meta SempMeta -

solace.semp: OauthProfileClientRequiredClaim

Fields

clientRequiredClaimName? string - The name of the ID token claim to verify. The minimum access scope/level required to retrieve this attribute is "global/read-only".

clientRequiredClaimValue? string - The required claim value, which must be a string containing a valid JSON value. The minimum access scope/level required to retrieve this attribute is "global/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileClientRequiredClaimLinks

Fields

uri? string - The URI of this Required Claim object.

solace.semp: OauthProfileClientRequiredClaimResponse

Fields

data? OauthProfileClientRequiredClaim -

links? OauthProfileClientRequiredClaimLinks -

meta SempMeta -

solace.semp: OauthProfileClientRequiredClaimsResponse

Fields

data? OauthProfileClientRequiredClaim[] -

links? OauthProfileClientRequiredClaimLinks[] -

meta SempMeta -

solace.semp: OauthProfileDefaultMsgVpnAccessLevelException

Fields

accessLevel? "none"|"read-only"|"read-write" - The message VPN access level. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - User has no access to a Message VPN. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. </pre>

msgVpnName? string - The name of the message VPN. The minimum access scope/level required to retrieve this attribute is "global/read-only".

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileDefaultMsgVpnAccessLevelExceptionLinks

Fields

uri? string - The URI of this Message VPN Access-Level Exception object.

solace.semp: OauthProfileDefaultMsgVpnAccessLevelExceptionResponse

Fields

data? OauthProfileDefaultMsgVpnAccessLevelException -

links? OauthProfileDefaultMsgVpnAccessLevelExceptionLinks -

meta SempMeta -

solace.semp: OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse

Fields

data? OauthProfileDefaultMsgVpnAccessLevelException[] -

links? OauthProfileDefaultMsgVpnAccessLevelExceptionLinks[] -

meta SempMeta -

solace.semp: OauthProfileLinks

Fields

accessLevelGroupsUri? string - The URI of this OAuth Profile's collection of Group Access Level objects.

clientAllowedHostsUri? string - The URI of this OAuth Profile's collection of Allowed Host Value objects.

clientAuthorizationParametersUri? string - The URI of this OAuth Profile's collection of Authorization Parameter objects.

clientRequiredClaimsUri? string - The URI of this OAuth Profile's collection of Required Claim objects.

defaultMsgVpnAccessLevelExceptionsUri? string - The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects.

resourceServerRequiredClaimsUri? string - The URI of this OAuth Profile's collection of Required Claim objects.

uri? string - The URI of this OAuth Profile object.

solace.semp: OauthProfileResourceServerRequiredClaim

Fields

oauthProfileName? string - The name of the OAuth profile. The minimum access scope/level required to retrieve this attribute is "global/read-only".

resourceServerRequiredClaimName? string - The name of the access token claim to verify. The minimum access scope/level required to retrieve this attribute is "global/read-only".

resourceServerRequiredClaimValue? string - The required claim value, which must be a string containing a valid JSON value. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: OauthProfileResourceServerRequiredClaimLinks

Fields

uri? string - The URI of this Required Claim object.

solace.semp: OauthProfileResourceServerRequiredClaimResponse

Fields

data? OauthProfileResourceServerRequiredClaim -

links? OauthProfileResourceServerRequiredClaimLinks -

meta SempMeta -

solace.semp: OauthProfileResourceServerRequiredClaimsResponse

Fields

data? OauthProfileResourceServerRequiredClaim[] -

links? OauthProfileResourceServerRequiredClaimLinks[] -

meta SempMeta -

solace.semp: OauthProfileResponse

Fields

data? OauthProfile -

links? OauthProfileLinks -

meta SempMeta -

solace.semp: OauthProfilesResponse

Fields

data? OauthProfile[] -

links? OauthProfileLinks[] -

meta SempMeta -

solace.semp: ProxiesResponse

Fields

data? Proxy[] -

links? ProxyLinks[] -

meta SempMeta -

solace.semp: Proxy

Fields

authenticationBasicPassword? string - The password to use with basic authentication. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions here. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationBasicUsername? string - The username to use with basic authentication. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

authenticationScheme? "none"|"basic" - The authentication scheme used to connect to the proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "none". The allowed values and their meaning are: <pre> "none" - No authentication. "basic" - Username/password authentication. </pre>

enabled? boolean - Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

host? string - The IP address or host name of the proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

port? Signed32 - The port to connect to on the proxy host. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

proxyName? string - The name of the proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only".

proxyType? "direct"|"http" - The type of proxy. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/admin". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "direct". The allowed values and their meaning are: <pre> "direct" - Direct connection (no proxy). "http" - HTTP proxy. </pre>

solace.semp: ProxyLinks

Fields

uri? string - The URI of this Proxy object.

solace.semp: ProxyResponse

Fields

data? Proxy -

links? ProxyLinks -

meta SempMeta -

solace.semp: ReplaceCertAuthorityQueries

Represents the Queries record for the operation: replaceCertAuthority

Fields

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

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.

solace.semp: ReplaceClientCertAuthorityQueries

Represents the Queries record for the operation: replaceClientCertAuthority

Fields

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

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.

solace.semp: ReplaceDmrClusterCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: replaceDmrClusterCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: ReplaceDmrClusterCertMatchingRuleQueries

Represents the Queries record for the operation: replaceDmrClusterCertMatchingRule

Fields

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

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.

solace.semp: ReplaceDmrClusterLinkQueries

Represents the Queries record for the operation: replaceDmrClusterLink

Fields

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

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.

solace.semp: ReplaceDmrClusterQueries

Represents the Queries record for the operation: replaceDmrCluster

Fields

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

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.

solace.semp: ReplaceDomainCertAuthorityQueries

Represents the Queries record for the operation: replaceDomainCertAuthority

Fields

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

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.

solace.semp: ReplaceMsgVpnAclProfileQueries

Represents the Queries record for the operation: replaceMsgVpnAclProfile

Fields

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

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.

solace.semp: ReplaceMsgVpnAuthenticationKerberosRealmQueries

Represents the Queries record for the operation: replaceMsgVpnAuthenticationKerberosRealm

Fields

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

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.

solace.semp: ReplaceMsgVpnAuthenticationOauthProfileQueries

Represents the Queries record for the operation: replaceMsgVpnAuthenticationOauthProfile

Fields

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

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.

solace.semp: ReplaceMsgVpnAuthenticationOauthProviderQueries

Represents the Queries record for the operation: replaceMsgVpnAuthenticationOauthProvider

Fields

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

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.

solace.semp: ReplaceMsgVpnAuthorizationGroupQueries

Represents the Queries record for the operation: replaceMsgVpnAuthorizationGroup

Fields

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

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.

solace.semp: ReplaceMsgVpnBridgeQueries

Represents the Queries record for the operation: replaceMsgVpnBridge

Fields

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

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.

solace.semp: ReplaceMsgVpnBridgeRemoteMsgVpnQueries

Represents the Queries record for the operation: replaceMsgVpnBridgeRemoteMsgVpn

Fields

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

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.

solace.semp: ReplaceMsgVpnCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: replaceMsgVpnCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: ReplaceMsgVpnCertMatchingRuleQueries

Represents the Queries record for the operation: replaceMsgVpnCertMatchingRule

Fields

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

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.

solace.semp: ReplaceMsgVpnClientProfileQueries

Represents the Queries record for the operation: replaceMsgVpnClientProfile

Fields

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

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.

solace.semp: ReplaceMsgVpnClientUsernameQueries

Represents the Queries record for the operation: replaceMsgVpnClientUsername

Fields

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

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.

solace.semp: ReplaceMsgVpnDistributedCacheClusterInstanceQueries

Represents the Queries record for the operation: replaceMsgVpnDistributedCacheClusterInstance

Fields

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

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.

solace.semp: ReplaceMsgVpnDistributedCacheClusterQueries

Represents the Queries record for the operation: replaceMsgVpnDistributedCacheCluster

Fields

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

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.

solace.semp: ReplaceMsgVpnDistributedCacheQueries

Represents the Queries record for the operation: replaceMsgVpnDistributedCache

Fields

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

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.

solace.semp: ReplaceMsgVpnDmrBridgeQueries

Represents the Queries record for the operation: replaceMsgVpnDmrBridge

Fields

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

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.

solace.semp: ReplaceMsgVpnJndiConnectionFactoryQueries

Represents the Queries record for the operation: replaceMsgVpnJndiConnectionFactory

Fields

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

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.

solace.semp: ReplaceMsgVpnJndiQueueQueries

Represents the Queries record for the operation: replaceMsgVpnJndiQueue

Fields

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

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.

solace.semp: ReplaceMsgVpnJndiTopicQueries

Represents the Queries record for the operation: replaceMsgVpnJndiTopic

Fields

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

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.

solace.semp: ReplaceMsgVpnKafkaReceiverQueries

Represents the Queries record for the operation: replaceMsgVpnKafkaReceiver

Fields

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

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.

solace.semp: ReplaceMsgVpnKafkaReceiverTopicBindingQueries

Represents the Queries record for the operation: replaceMsgVpnKafkaReceiverTopicBinding

Fields

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

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.

solace.semp: ReplaceMsgVpnKafkaSenderQueries

Represents the Queries record for the operation: replaceMsgVpnKafkaSender

Fields

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

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.

solace.semp: ReplaceMsgVpnKafkaSenderQueueBindingQueries

Represents the Queries record for the operation: replaceMsgVpnKafkaSenderQueueBinding

Fields

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

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.

solace.semp: ReplaceMsgVpnMqttRetainCacheQueries

Represents the Queries record for the operation: replaceMsgVpnMqttRetainCache

Fields

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

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.

solace.semp: ReplaceMsgVpnMqttSessionQueries

Represents the Queries record for the operation: replaceMsgVpnMqttSession

Fields

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

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.

solace.semp: ReplaceMsgVpnMqttSessionSubscriptionQueries

Represents the Queries record for the operation: replaceMsgVpnMqttSessionSubscription

Fields

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

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.

solace.semp: ReplaceMsgVpnProxyQueries

Represents the Queries record for the operation: replaceMsgVpnProxy

Fields

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

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.

solace.semp: ReplaceMsgVpnQueries

Represents the Queries record for the operation: replaceMsgVpn

Fields

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

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.

solace.semp: ReplaceMsgVpnQueueQueries

Represents the Queries record for the operation: replaceMsgVpnQueue

Fields

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

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.

solace.semp: ReplaceMsgVpnQueueTemplateQueries

Represents the Queries record for the operation: replaceMsgVpnQueueTemplate

Fields

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

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.

solace.semp: ReplaceMsgVpnReplayLogQueries

Represents the Queries record for the operation: replaceMsgVpnReplayLog

Fields

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

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.

solace.semp: ReplaceMsgVpnReplicatedTopicQueries

Represents the Queries record for the operation: replaceMsgVpnReplicatedTopic

Fields

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

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.

solace.semp: ReplaceMsgVpnRestDeliveryPointQueries

Represents the Queries record for the operation: replaceMsgVpnRestDeliveryPoint

Fields

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

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.

solace.semp: ReplaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries

Represents the Queries record for the operation: replaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Fields

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

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.

solace.semp: ReplaceMsgVpnRestDeliveryPointQueueBindingQueries

Represents the Queries record for the operation: replaceMsgVpnRestDeliveryPointQueueBinding

Fields

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

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.

solace.semp: ReplaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries

Represents the Queries record for the operation: replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader

Fields

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

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.

solace.semp: ReplaceMsgVpnRestDeliveryPointRestConsumerQueries

Represents the Queries record for the operation: replaceMsgVpnRestDeliveryPointRestConsumer

Fields

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

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.

solace.semp: ReplaceMsgVpnTelemetryProfileQueries

Represents the Queries record for the operation: replaceMsgVpnTelemetryProfile

Fields

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

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.

solace.semp: ReplaceMsgVpnTelemetryProfileTraceFilterQueries

Represents the Queries record for the operation: replaceMsgVpnTelemetryProfileTraceFilter

Fields

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

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.

solace.semp: ReplaceMsgVpnTopicEndpointQueries

Represents the Queries record for the operation: replaceMsgVpnTopicEndpoint

Fields

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

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.

solace.semp: ReplaceMsgVpnTopicEndpointTemplateQueries

Represents the Queries record for the operation: replaceMsgVpnTopicEndpointTemplate

Fields

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

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.

solace.semp: ReplaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Fields

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

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.

solace.semp: ReplaceOauthProfileAccessLevelGroupQueries

Represents the Queries record for the operation: replaceOauthProfileAccessLevelGroup

Fields

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

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.

solace.semp: ReplaceOauthProfileClientAuthorizationParameterQueries

Represents the Queries record for the operation: replaceOauthProfileClientAuthorizationParameter

Fields

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

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.

solace.semp: ReplaceOauthProfileDefaultMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: replaceOauthProfileDefaultMsgVpnAccessLevelException

Fields

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

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.

solace.semp: ReplaceOauthProfileQueries

Represents the Queries record for the operation: replaceOauthProfile

Fields

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

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.

solace.semp: ReplaceProxyQueries

Represents the Queries record for the operation: replaceProxy

Fields

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

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.

solace.semp: ReplaceVirtualHostnameQueries

Represents the Queries record for the operation: replaceVirtualHostname

Fields

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

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.

solace.semp: SempError

Fields

code Signed32 - The error code which uniquely identifies the error that has occurred.

description string - The verbose description of the problem.

status string - The terse status string associated with code.

solace.semp: SempMeta

Fields

count? int - The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results. This attribute is only supported for specific collections.

'error? SempError -

paging? SempPaging -

request SempRequest -

responseCode Signed32 - The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error).

solace.semp: SempMetaOnlyResponse

Fields

meta SempMeta -

solace.semp: SempPaging

Fields

cursorQuery string - The cursor, or position, for the next page of objects. Use this as the cursor query parameter of the next request.

nextPageUri string - The URI of the next page of objects. cursorQuery is already embedded within this URI.

solace.semp: SempRequest

Fields

method string - The HTTP method of the request which resulted in this response.

uri? string - The URI of the request which resulted in this response. The URI may be normalized.

solace.semp: SystemInformation

Fields

platform? string - The platform running the SEMP API. The minimum access scope/level required to retrieve this attribute is "global/none". Deprecated since 2.2. /systemInformation was replaced by /about/api.

sempVersion? string - The version of the SEMP API. The minimum access scope/level required to retrieve this attribute is "global/none". Deprecated since 2.2. /systemInformation was replaced by /about/api.

solace.semp: SystemInformationLinks

Fields

uri? string - The URI of this System Information object.

solace.semp: SystemInformationResponse

Fields

data? SystemInformation -

links? SystemInformationLinks -

meta SempMeta -

solace.semp: UpdateBrokerQueries

Represents the Queries record for the operation: updateBroker

Fields

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

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.

solace.semp: UpdateCertAuthorityQueries

Represents the Queries record for the operation: updateCertAuthority

Fields

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

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.

solace.semp: UpdateClientCertAuthorityQueries

Represents the Queries record for the operation: updateClientCertAuthority

Fields

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

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.

solace.semp: UpdateDmrClusterCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: updateDmrClusterCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: UpdateDmrClusterCertMatchingRuleQueries

Represents the Queries record for the operation: updateDmrClusterCertMatchingRule

Fields

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

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.

solace.semp: UpdateDmrClusterLinkQueries

Represents the Queries record for the operation: updateDmrClusterLink

Fields

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

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.

solace.semp: UpdateDmrClusterQueries

Represents the Queries record for the operation: updateDmrCluster

Fields

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

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.

solace.semp: UpdateDomainCertAuthorityQueries

Represents the Queries record for the operation: updateDomainCertAuthority

Fields

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

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.

solace.semp: UpdateMsgVpnAclProfileQueries

Represents the Queries record for the operation: updateMsgVpnAclProfile

Fields

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

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.

solace.semp: UpdateMsgVpnAuthenticationKerberosRealmQueries

Represents the Queries record for the operation: updateMsgVpnAuthenticationKerberosRealm

Fields

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

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.

solace.semp: UpdateMsgVpnAuthenticationOauthProfileQueries

Represents the Queries record for the operation: updateMsgVpnAuthenticationOauthProfile

Fields

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

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.

solace.semp: UpdateMsgVpnAuthenticationOauthProviderQueries

Represents the Queries record for the operation: updateMsgVpnAuthenticationOauthProvider

Fields

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

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.

solace.semp: UpdateMsgVpnAuthorizationGroupQueries

Represents the Queries record for the operation: updateMsgVpnAuthorizationGroup

Fields

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

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.

solace.semp: UpdateMsgVpnBridgeQueries

Represents the Queries record for the operation: updateMsgVpnBridge

Fields

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

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.

solace.semp: UpdateMsgVpnBridgeRemoteMsgVpnQueries

Represents the Queries record for the operation: updateMsgVpnBridgeRemoteMsgVpn

Fields

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

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.

solace.semp: UpdateMsgVpnCertMatchingRuleAttributeFilterQueries

Represents the Queries record for the operation: updateMsgVpnCertMatchingRuleAttributeFilter

Fields

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

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.

solace.semp: UpdateMsgVpnCertMatchingRuleQueries

Represents the Queries record for the operation: updateMsgVpnCertMatchingRule

Fields

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

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.

solace.semp: UpdateMsgVpnClientProfileQueries

Represents the Queries record for the operation: updateMsgVpnClientProfile

Fields

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

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.

solace.semp: UpdateMsgVpnClientUsernameQueries

Represents the Queries record for the operation: updateMsgVpnClientUsername

Fields

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

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.

solace.semp: UpdateMsgVpnDistributedCacheClusterInstanceQueries

Represents the Queries record for the operation: updateMsgVpnDistributedCacheClusterInstance

Fields

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

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.

solace.semp: UpdateMsgVpnDistributedCacheClusterQueries

Represents the Queries record for the operation: updateMsgVpnDistributedCacheCluster

Fields

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

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.

solace.semp: UpdateMsgVpnDistributedCacheQueries

Represents the Queries record for the operation: updateMsgVpnDistributedCache

Fields

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

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.

solace.semp: UpdateMsgVpnDmrBridgeQueries

Represents the Queries record for the operation: updateMsgVpnDmrBridge

Fields

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

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.

solace.semp: UpdateMsgVpnJndiConnectionFactoryQueries

Represents the Queries record for the operation: updateMsgVpnJndiConnectionFactory

Fields

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

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.

solace.semp: UpdateMsgVpnJndiQueueQueries

Represents the Queries record for the operation: updateMsgVpnJndiQueue

Fields

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

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.

solace.semp: UpdateMsgVpnJndiTopicQueries

Represents the Queries record for the operation: updateMsgVpnJndiTopic

Fields

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

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.

solace.semp: UpdateMsgVpnKafkaReceiverQueries

Represents the Queries record for the operation: updateMsgVpnKafkaReceiver

Fields

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

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.

solace.semp: UpdateMsgVpnKafkaReceiverTopicBindingQueries

Represents the Queries record for the operation: updateMsgVpnKafkaReceiverTopicBinding

Fields

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

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.

solace.semp: UpdateMsgVpnKafkaSenderQueries

Represents the Queries record for the operation: updateMsgVpnKafkaSender

Fields

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

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.

solace.semp: UpdateMsgVpnKafkaSenderQueueBindingQueries

Represents the Queries record for the operation: updateMsgVpnKafkaSenderQueueBinding

Fields

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

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.

solace.semp: UpdateMsgVpnMqttRetainCacheQueries

Represents the Queries record for the operation: updateMsgVpnMqttRetainCache

Fields

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

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.

solace.semp: UpdateMsgVpnMqttSessionQueries

Represents the Queries record for the operation: updateMsgVpnMqttSession

Fields

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

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.

solace.semp: UpdateMsgVpnMqttSessionSubscriptionQueries

Represents the Queries record for the operation: updateMsgVpnMqttSessionSubscription

Fields

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

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.

solace.semp: UpdateMsgVpnProxyQueries

Represents the Queries record for the operation: updateMsgVpnProxy

Fields

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

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.

solace.semp: UpdateMsgVpnQueries

Represents the Queries record for the operation: updateMsgVpn

Fields

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

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.

solace.semp: UpdateMsgVpnQueueQueries

Represents the Queries record for the operation: updateMsgVpnQueue

Fields

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

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.

solace.semp: UpdateMsgVpnQueueTemplateQueries

Represents the Queries record for the operation: updateMsgVpnQueueTemplate

Fields

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

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.

solace.semp: UpdateMsgVpnReplayLogQueries

Represents the Queries record for the operation: updateMsgVpnReplayLog

Fields

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

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.

solace.semp: UpdateMsgVpnReplicatedTopicQueries

Represents the Queries record for the operation: updateMsgVpnReplicatedTopic

Fields

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

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.

solace.semp: UpdateMsgVpnRestDeliveryPointQueries

Represents the Queries record for the operation: updateMsgVpnRestDeliveryPoint

Fields

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

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.

solace.semp: UpdateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderQueries

Represents the Queries record for the operation: updateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader

Fields

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

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.

solace.semp: UpdateMsgVpnRestDeliveryPointQueueBindingQueries

Represents the Queries record for the operation: updateMsgVpnRestDeliveryPointQueueBinding

Fields

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

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.

solace.semp: UpdateMsgVpnRestDeliveryPointQueueBindingRequestHeaderQueries

Represents the Queries record for the operation: updateMsgVpnRestDeliveryPointQueueBindingRequestHeader

Fields

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

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.

solace.semp: UpdateMsgVpnRestDeliveryPointRestConsumerQueries

Represents the Queries record for the operation: updateMsgVpnRestDeliveryPointRestConsumer

Fields

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

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.

solace.semp: UpdateMsgVpnTelemetryProfileQueries

Represents the Queries record for the operation: updateMsgVpnTelemetryProfile

Fields

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

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.

solace.semp: UpdateMsgVpnTelemetryProfileTraceFilterQueries

Represents the Queries record for the operation: updateMsgVpnTelemetryProfileTraceFilter

Fields

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

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.

solace.semp: UpdateMsgVpnTopicEndpointQueries

Represents the Queries record for the operation: updateMsgVpnTopicEndpoint

Fields

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

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.

solace.semp: UpdateMsgVpnTopicEndpointTemplateQueries

Represents the Queries record for the operation: updateMsgVpnTopicEndpointTemplate

Fields

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

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.

solace.semp: UpdateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException

Fields

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

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.

solace.semp: UpdateOauthProfileAccessLevelGroupQueries

Represents the Queries record for the operation: updateOauthProfileAccessLevelGroup

Fields

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

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.

solace.semp: UpdateOauthProfileClientAuthorizationParameterQueries

Represents the Queries record for the operation: updateOauthProfileClientAuthorizationParameter

Fields

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

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.

solace.semp: UpdateOauthProfileDefaultMsgVpnAccessLevelExceptionQueries

Represents the Queries record for the operation: updateOauthProfileDefaultMsgVpnAccessLevelException

Fields

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

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.

solace.semp: UpdateOauthProfileQueries

Represents the Queries record for the operation: updateOauthProfile

Fields

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

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.

solace.semp: UpdateProxyQueries

Represents the Queries record for the operation: updateProxy

Fields

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

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.

solace.semp: UpdateVirtualHostnameQueries

Represents the Queries record for the operation: updateVirtualHostname

Fields

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

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.

solace.semp: VirtualHostname

Fields

enabled? boolean - Enable or disable Virtual Hostname to Message VPN mapping. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

msgVpnName? string - The message VPN to which this virtual hostname is mapped. The minimum access scope/level required to retrieve this attribute is "global/read-only". The minimum access scope/level required to change this attribute is "global/read-write". Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

virtualHostname? string - The virtual hostname. The minimum access scope/level required to retrieve this attribute is "global/read-only".

solace.semp: VirtualHostnameLinks

Fields

uri? string - The URI of this Virtual Hostname object.

solace.semp: VirtualHostnameResponse

Fields

data? VirtualHostname -

links? VirtualHostnameLinks -

meta SempMeta -

solace.semp: VirtualHostnamesResponse

Fields

data? VirtualHostname[] -

links? VirtualHostnameLinks[] -

meta SempMeta -

Import

import xlibb/solace.semp;

Other versions

0.2.0

Metadata

Released date: 6 months ago

Version: 0.2.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 709

Current verison: 709

Weekly downloads

Source repository

Keywords

Solace

Management

Contributors

Dependencies

ballerina/io/1.8.0 ballerina/constraint/1.7.0 ballerina/data.jsondata/1.1.3

Cookie policy

Delete policy

clients

records

xlibb/solace.semp

Ballerina Solace SEMP v2 Connector

Clients

solace.semp: Client

Constructor

getBroker

Parameters

Return Type

updateBroker

Parameters

Return Type

getAbout

Parameters

Return Type

getAboutApi

Parameters

Return Type

getAboutUser

Parameters

Return Type

getAboutUserMsgVpns

Parameters

Return Type

getAboutUserMsgVpn

Parameters

Return Type

getCertAuthorities

Parameters

Return Type

Deprecated

createCertAuthority

Parameters

Return Type

Deprecated

getCertAuthority

Parameters

Return Type

Deprecated

replaceCertAuthority

Parameters

Return Type

Deprecated

deleteCertAuthority

Parameters

Return Type

Deprecated

updateCertAuthority

Parameters

Return Type

Deprecated

getCertAuthorityOcspTlsTrustedCommonNames

Parameters

Return Type

Deprecated

createCertAuthorityOcspTlsTrustedCommonName

Parameters

Return Type

Deprecated

getCertAuthorityOcspTlsTrustedCommonName

Parameters

Return Type

Deprecated

deleteCertAuthorityOcspTlsTrustedCommonName

Parameters

Return Type

Deprecated

getClientCertAuthorities

Parameters

Return Type

createClientCertAuthority

Parameters

Return Type

getClientCertAuthority

Parameters

Return Type

replaceClientCertAuthority

Parameters

Return Type