solace_acl_publish_topic_exception – publish topic exception for acl profile

Configure a publish topic exception object for an ACL Profile.

Allows addition and removal of a publish topic exception object for an ACL Profile.

Examples

hosts: all
gather_facts: no
any_errors_fatal: true
collections:
- solace.pubsub_plus
module_defaults:
 solace_acl_profile:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
 solace_acl_publish_topic_exception:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
tasks:
  - name: Create ACL Profile
    solace_acl_profile:
        name: "test_ansible_solace"
        settings:
            clientConnectDefaultAction: "disallow"
            publishTopicDefaultAction: "disallow"
            subscribeTopicDefaultAction: "disallow"
        state: present

  - name: Add Publish Topic Exceptions to ACL Profile
    solace_acl_publish_topic_exception:
        acl_profile_name: "test_ansible_solace"
        name: "test/ansible/solace"
        state: present

  - name: Delete Publish Topic Exceptions from ACL Profile
    solace_acl_publish_topic_exception:
        acl_profile_name: "test_ansible_solace"
        name: "test/ansible/solace"
        state: absent

Notes

Note

See Also

See also

Parameters

acl_profile_name (required)

The ACL Profile.

type: str
host (optional)

Hostname of Solace Broker.

type: str
default: localhost
msg_vpn (required)

The message vpn.

type: str
name (required)

The name (topic) of the publish topic exception. Maps to ‘publishTopicException’ in the SEMP v2 API.

type: str
aliases: topic
password (optional)

Administrator password for Solace Broker.

type: str
default: admin
port (optional)

Management port of Solace Broker.

type: int
default: 8080
reverse_proxy (optional)

Use a reverse proxy / api gateway. Note: Experimental. Not permitted for Solace Cloud API.

type: dict
headers (optional)

Additional headers to add to the http call. Example: ‘apiKey: {my-api-key}’.

type: dict
x-asc-module (optional)

Flag for the module to add the header ‘x-asc-module:{module-name}’ to the http call with it’s module name.

type: bool
default: False
x-asc-module-op (optional)

Flag for the module to add the header ‘x-asc-module-op:{module operation}’ to the http call with the module’s operation.

type: bool
default: False
query_params (optional)

Additional query paramters to add to the URL. Example: ‘apiCode: {my-api-code}’.

type: dict
semp_base_path (optional)

Base path prepended to all SEMP calls. Example: ‘my/base/path’. Resulting URL will be: http(s)://{host}:{port}/{semp_base_path}/{module-semp-call-path}

type: str
use_basic_auth (optional)

Flag to use basic authentication in the http(s) call or not. Uses ‘username’/’password’.

type: bool
default: False
secure_connection (optional)

If true, use https rather than http.

type: bool
default: False
sempv2_settings (optional)

JSON dictionary of additional configuration for the SEMP V2 API. See Reference documentation.

type: dict
aliases: settings
state (optional)

Target state.

type: str
default: present
choices: present, absent
timeout (optional)

Connection timeout in seconds for the http request.

type: int
default: 10
topic_syntax (optional)

The topic syntax.

type: str
default: smf
choices: smf, mqtt
username (optional)

Administrator username for Solace Broker.

type: str
default: admin
validate_certs (optional)

Flag to switch validation of client certificates on/off when using a secure connection.

type: bool
default: True
x_broker (optional)

Custom HTTP header with the broker virtual router id, if using a SEMPv2 Proxy/agent infrastructure.

type: str

Return Values

response

The response from the Solace Sempv2 request.

returned: success
type: dict
sample:
  {
  "aclProfileName": "test_ansible_solace",
  "msgVpnName": "default",
  "publishTopicException": "test/ansible/solace",
  "publishTopicExceptionSyntax": "smf"
}
msg

The response from the HTTP call in case of error.

returned: error
type: dict
rc

Return code. rc=0 on success, rc=1 on error.

returned: always
type: int
sample:
  {
  "error": {
    "rc": 1
  },
  "success": {
    "rc": 0
  }
}