Static
createThe Cluster object's attributes. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Certificate Matching Rule object. Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Certificate Matching Rule Attribute Filter object. Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
filterName | x | x | ||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule Attribute Filter object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Certificate Matching Rule Condition object. Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
ruleName | x | x | ||||
source | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleConditionResponse The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule Condition object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Link object. Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
authenticationBasicPassword | x | x | ||||
dmrClusterName | x | x | ||||
remoteNodeName | x | x |
The following attributes in the request may only be provided in certain combinations with other attributes:
Class | Attribute | Requires | Conflicts |
---|---|---|---|
EventThreshold | clearPercent | setPercent | clearValue, setValue |
EventThreshold | clearValue | setValue | clearPercent, setPercent |
EventThreshold | setPercent | clearPercent | clearValue, setValue |
EventThreshold | setValue | clearValue | clearPercent, setPercent |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkResponse The Link object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Link object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Link Attribute object. Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
attributeName | x | x | ||||
attributeValue | x | x | ||||
dmrClusterName | x | x | ||||
remoteNodeName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterLinkAttributeResponse The Link Attribute object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Link Attribute object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Remote Address object. Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
remoteAddress | x | x | ||||
remoteNodeName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkRemoteAddressResponse The Remote Address object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Remote Address object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
createCreate a Trusted Common Name object. Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.
Attribute | Identifying | Required | Read-Only | Write-Only | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | x | |||
remoteNodeName | x | x | x | |||
tlsTrustedCommonName | x | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.
DmrClusterLinkTlsTrustedCommonNameResponse The Trusted Common Name object's attributes after being created, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Trusted Common Name object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Cluster object. Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Certificate Matching Rule object. Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
The name of the rule. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Certificate Matching Rule Attribute Filter object. Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
The name of the filter. *
The name of the rule. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Certificate Matching Rule Condition object. Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
The name of the rule. *
Certificate field to be compared with the Attribute. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Link object. Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
The name of the node at the remote end of the Link. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Link Attribute object. Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync.
A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Attribute. *
The value of the Attribute. *
The name of the Cluster. *
The name of the node at the remote end of the Link. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Remote Address object. Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync.
Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
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 name of the node at the remote end of the Link. *
Optional
xOptional context id the request is running. *
Static
deleteDelete a Trusted Common Name object. Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.
The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.
SempMetaOnlyResponse The request metadata.
ApiError
The name of the Cluster. *
The name of the node at the remote end of the Link. *
The expected trusted common name of the remote certificate. *
Optional
xOptional context id the request is running. *
Static
getGet a Cluster object. Get a Cluster object.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
authenticationBasicPassword | x | x | ||
authenticationClientCertContent | x | x | ||
authenticationClientCertPassword | x | |||
dmrClusterName | x | |||
tlsServerCertEnforceTrustedCommonNameEnabled | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClusterResponse The Cluster object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Certificate Matching Rule object. Get a Certificate Matching Rule object.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
ruleName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleResponse The Certificate Matching Rule object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Certificate Matching Rule Attribute Filter object. Get a Certificate Matching Rule Attribute Filter object.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
filterName | x | |||
ruleName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
The name of the filter. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Certificate Matching Rule Attribute Filter objects. Get a list of Certificate Matching Rule Attribute Filter objects.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
filterName | x | |||
ruleName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleAttributeFiltersResponse The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Certificate Matching Rule Condition object. Get a Certificate Matching Rule Condition object.
A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
ruleName | x | |||
source | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleConditionResponse The Certificate Matching Rule Condition object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Certificate field to be compared with the Attribute. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Certificate Matching Rule Condition objects. Get a list of Certificate Matching Rule Condition objects.
A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
ruleName | x | |||
source | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleConditionsResponse The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Certificate Matching Rule objects. Get a list of Certificate Matching Rule objects.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
ruleName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRulesResponse The list of Certificate Matching Rule objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Link object. Get a Link object.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
authenticationBasicPassword | x | x | ||
dmrClusterName | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkResponse The Link object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Link Attribute object. Get a Link Attribute object.
A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
attributeName | x | |||
attributeValue | x | |||
dmrClusterName | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterLinkAttributeResponse The Link Attribute object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Attribute. *
The value of the Attribute. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Link Attribute objects. Get a list of Link Attribute objects.
A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
attributeName | x | |||
attributeValue | x | |||
dmrClusterName | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.28.
DmrClusterLinkAttributesResponse The list of Link Attribute objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Remote Address object. Get a Remote Address object.
Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
remoteAddress | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkRemoteAddressResponse The Remote Address object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
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 name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Remote Address objects. Get a list of Remote Address objects.
Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | |||
remoteAddress | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkRemoteAddressesResponse The list of Remote Address objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a Trusted Common Name object. Get a Trusted Common Name object.
The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | x | ||
remoteNodeName | x | x | ||
tlsTrustedCommonName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.
DmrClusterLinkTlsTrustedCommonNameResponse The Trusted Common Name object's attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
The expected trusted common name of the remote certificate. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Trusted Common Name objects. Get a list of Trusted Common Name objects.
The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
dmrClusterName | x | x | ||
remoteNodeName | x | x | ||
tlsTrustedCommonName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.
DmrClusterLinkTlsTrustedCommonNamesResponse The list of Trusted Common Name objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Link objects. Get a list of Link objects.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
authenticationBasicPassword | x | x | ||
dmrClusterName | x | |||
remoteNodeName | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinksResponse The list of Link objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
getGet a list of Cluster objects. Get a list of Cluster objects.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
Attribute | Identifying | Write-Only | Deprecated | Opaque |
---|---|---|---|---|
authenticationBasicPassword | x | x | ||
authenticationClientCertContent | x | x | ||
authenticationClientCertPassword | x | |||
dmrClusterName | x | |||
tlsServerCertEnforceTrustedCommonNameEnabled | x |
A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
This has been available since 2.11.
DmrClustersResponse The list of Cluster objects' attributes, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
Optional
count?: numberLimit the count of objects in the response. See the documentation for the count
parameter. *
Optional
cursor?: stringThe cursor, or position, for the next page of objects. See the documentation for the cursor
parameter. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
where?: string[]Include in the response only objects where certain conditions are true. See the the documentation for the where
parameter. *
Optional
xOptional context id the request is running. *
Static
replaceReplace a Cluster object. Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
Attribute | Identifying | Const | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|---|
authenticationBasicPassword | x | x | x | ||||
authenticationClientCertContent | x | x | x | ||||
authenticationClientCertPassword | x | x | |||||
directOnlyEnabled | x | ||||||
dmrClusterName | x | x | |||||
nodeName | x | ||||||
tlsServerCertEnforceTrustedCommonNameEnabled | x |
The following attributes in the request may only be provided in certain combinations with other attributes:
Class | Attribute | Requires | Conflicts |
---|---|---|---|
DmrCluster | authenticationClientCertPassword | authenticationClientCertContent |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterResponse The Cluster object's attributes after being replaced, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Cluster object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
replaceReplace a Certificate Matching Rule object. Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
Attribute | Identifying | Const | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|---|
dmrClusterName | x | x | |||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being replaced, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
replaceReplace a Certificate Matching Rule Attribute Filter object. Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
Attribute | Identifying | Const | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|---|
dmrClusterName | x | x | |||||
filterName | x | x | |||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule Attribute Filter object's attributes. *
The name of the Cluster. *
The name of the filter. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
replaceReplace a Link object. Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
Attribute | Identifying | Const | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|---|
authenticationBasicPassword | x | x | x | ||||
authenticationScheme | x | ||||||
dmrClusterName | x | x | |||||
egressFlowWindowSize | x | ||||||
initiator | x | ||||||
remoteNodeName | x | x | |||||
span | x | ||||||
transportCompressedEnabled | x | ||||||
transportTlsEnabled | x |
The following attributes in the request may only be provided in certain combinations with other attributes:
Class | Attribute | Requires | Conflicts |
---|---|---|---|
EventThreshold | clearPercent | setPercent | clearValue, setValue |
EventThreshold | clearValue | setValue | clearPercent, setPercent |
EventThreshold | setPercent | clearPercent | clearValue, setValue |
EventThreshold | setValue | clearValue | clearPercent, setPercent |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkResponse The Link object's attributes after being replaced, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Link object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
updateUpdate a Cluster object. Update a Cluster object. Any attribute missing from the request will be left unchanged.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
Attribute | Identifying | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|
authenticationBasicPassword | x | x | x | |||
authenticationClientCertContent | x | x | x | |||
authenticationClientCertPassword | x | x | ||||
directOnlyEnabled | x | |||||
dmrClusterName | x | x | ||||
nodeName | x | |||||
tlsServerCertEnforceTrustedCommonNameEnabled | x |
The following attributes in the request may only be provided in certain combinations with other attributes:
Class | Attribute | Requires | Conflicts |
---|---|---|---|
DmrCluster | authenticationClientCertPassword | authenticationClientCertContent |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterResponse The Cluster object's attributes after being updated, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Cluster object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
updateUpdate a Certificate Matching Rule object. Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.
A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
Attribute | Identifying | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being updated, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
updateUpdate a Certificate Matching Rule Attribute Filter object. Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.
A Cert Matching Rule Attribute Filter compares a link attribute to a string.
Attribute | Identifying | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|
dmrClusterName | x | x | ||||
filterName | x | x | ||||
ruleName | x | x |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.28.
DmrClusterCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Certificate Matching Rule Attribute Filter object's attributes. *
The name of the Cluster. *
The name of the filter. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the rule. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Static
updateUpdate a Link object. Update a Link object. Any attribute missing from the request will be left unchanged.
A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
Attribute | Identifying | Read-Only | Write-Only | Requires-Disable | Deprecated | Opaque |
---|---|---|---|---|---|---|
authenticationBasicPassword | x | x | x | |||
authenticationScheme | x | |||||
dmrClusterName | x | x | ||||
egressFlowWindowSize | x | |||||
initiator | x | |||||
remoteNodeName | x | x | ||||
span | x | |||||
transportCompressedEnabled | x | |||||
transportTlsEnabled | x |
The following attributes in the request may only be provided in certain combinations with other attributes:
Class | Attribute | Requires | Conflicts |
---|---|---|---|
EventThreshold | clearPercent | setPercent | clearValue, setValue |
EventThreshold | clearValue | setValue | clearPercent, setPercent |
EventThreshold | setPercent | clearPercent | clearValue, setValue |
EventThreshold | setValue | clearValue | clearPercent, setPercent |
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
DmrClusterLinkResponse The Link object's attributes after being updated, and the request metadata.
SempMetaOnlyResponse The error response.
ApiError
The Link object's attributes. *
The name of the Cluster. *
Optional
opaqueAccept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword
parameter. *
The name of the node at the remote end of the Link. *
Optional
select?: string[]Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select
parameter. *
Optional
xOptional context id the request is running. *
Create a Cluster object. Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.
A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
The following attributes in the request may only be provided in certain combinations with other attributes:
A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.
This has been available since 2.11.
Returns
DmrClusterResponse The Cluster object's attributes after being created, and the request metadata.
Returns
SempMetaOnlyResponse The error response.
Throws
ApiError