solace_acl_publish_topic_exceptions – list of publish topic exceptions on an acl profile

Configure a list of Publish Topic Exception objects on an ACL Profile in a single transaction.

Allows addition and removal of a list of Publish Topic Exception objects as well as replacement of all existing Publish Topic Exception objects on an ACL Profile.

Supports ‘transactional’ behavior with rollback to original list in case of error.

De-duplicates Publish Topic Exception object list.

Reports which topics were added, deleted and omitted (duplicates). In case of an error, reports the invalid Publish Topic Exception object.

To delete all Publish Topic Exception objects, use state=’exactly’ with an empty/null list (see examples).

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 }}"
    reverse_proxy: "{{ semp_reverse_proxy | default(omit) }}"
  solace_acl_publish_topic_exceptions:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
    reverse_proxy: "{{ semp_reverse_proxy | default(omit) }}"
  solace_get_acl_publish_topic_exceptions:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
    reverse_proxy: "{{ semp_reverse_proxy | default(omit) }}"
tasks:
  - name: create acl profile
    solace_acl_profile:
      name: foo
      state: present

  - name: add list of exceptions
    solace_acl_publish_topic_exceptions:
      acl_profile_name: foo
      topics:
        - topic_1
        - topic_2
      state: present

  - name: get list of exceptions
    solace_get_acl_publish_topic_exceptions:
      acl_profile_name: foo

  - name: add second list of exceptions
    solace_acl_publish_topic_exceptions:
      acl_profile_name: foo
      topics:
        - topic_3
        - topic_4
      state: present

  - name: get list of exceptions
    solace_get_acl_publish_topic_exceptions:
      acl_profile_name: foo

  - name: replace list of exceptions
    solace_acl_publish_topic_exceptions:
      acl_profile_name: foo
      topics:
        - new_topic_1
        - new_topic_2
      state: exactly

  - name: get list of exceptions
    solace_get_acl_publish_topic_exceptions:
      acl_profile_name: foo

  - name: delete all exceptions
    solace_acl_publish_topic_exceptions:
      acl_profile_name: foo
      topics: null
      state: exactly

  - name: get list of exceptions
    solace_get_acl_publish_topic_exceptions:
      acl_profile_name: foo

  - name: delete acl profile
    solace_acl_profile:
      name: foo
      state: absent

Notes

Note

• Module Sempv2 Config: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/config/index.html#/aclProfile/createMsgVpnAclProfilePublishTopicException

• Sempv2 Config Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/config/index.html#/

• Sempv2 Monitor Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/monitor/index.html#/

• Sempv2 Action Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/action/index.html#/

• Updating the settings on a list is not supported.

See Also

See also

• solace_acl_profile – configure acl profile

• solace_acl_publish_topic_exception – publish topic exception for acl profile

• solace_get_acl_publish_topic_exceptions – get list of publish topic exceptions on an acl profile

Parameters

acl_profile_name (required)

The ACL Profile. Maps to ‘aclProfileName’ in the SEMP v2 API.

type: str

host (optional)

Hostname of Solace Broker.

type: str

default: localhost

msg_vpn (required)

The message vpn.

type: str

names (required)

The publish topic. Maps to ‘publishTopicException’ in the SEMP v2 API.

type: list

aliases: topics

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 for CRUD list operation.

type: str

default: present

choices: present, absent, exactly

timeout (optional)

Connection timeout in seconds for the http request.

type: int

default: 10

topic_syntax (optional)

The topic syntax. Maps to ‘publishTopicExceptionSyntax’ in the SEMP v2 API.

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 of the operation.

returned: always

type: dict

sample:

  {
  "error": {
    "response": [
      {
        "error": "/invalid-topic"
      }
    ]
  },
  "success": {
    "response": [
      {
        "added": "topic-6"
      },
      {
        "added": "topic-7"
      },
      {
        "added": "duplicate-topic"
      },
      {
        "deleted": "topic-1"
      },
      {
        "deleted": "topic-2"
      },
      {
        "deleted": "topic-3"
      },
      {
        "deleted": "topic-4"
      },
      {
        "deleted": "topic-5"
      },
      {
        "duplicate": "duplicate-topic"
      }
    ]
  }
}

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
  }
}