ansible-solace

Ansible module(s) to configure Solace Brokers via SEMP v2.

QUICKSTART

In order to use these modules, Ansible needs to know about them. You can either copy the files into one of Ansible's expected locations (per Adding modules and plugins locally) or you can set the ANSIBLE_MODULE_UTILS and ANSIBLE_LIBRARY environment variables at runtime:

ANSIBLE_MODULE_UTILS=$(pwd)/lib/ansible/module_utils \
ANSIBLE_LIBRARY=$(pwd)/lib/ansible/modules \
ansible-playbook examples/solace_vpn.yml

EXAMPLES

# Create a vpn with default settings
- name: Create vpn foo
  solace_vpn:
    name: foo
# Ensure a vpn called bar does not exist
- name: Remove vpn bar
  solace_vpn:
    name: bar
    state: absent
# Set specific vpn setting on foo
- name: Set MQTT listen port to 1234 on vpn foo
  solace_vpn:
    name: foo
    settings:
      serviceMqttPlainTextListenPort: 1234
# Add a queue to VPN foo
- name: Add a queue to VPN foo
  solace_queue:
    name: baz
    msg_vpn: foo
    settings:
      owner: "admin"

MODULES

Status of the solace_* modules:

Module	SEMP Endpoint	Type	Status	Example
solace_about	about	Query
solace_acl_profile	aclProfile	Action	☀️	📄
solace_acl_connect	aclProfile	Action	☀️	📄
solace_acl_publish	aclProfile	Action	☀️	📄
solace_acl_subscribe	aclProfile	Action	☀️	📄
solace_acl_publish_exception (deprecated)	aclProfile	Action	☀️
solace_acl_subscribe_exception (deprecated)	aclProfile	Action	☀️
solace_authorization_group	authorizationGroup	Action
solace_bridge	bridge	Action	☀️	📄
solace_bridge_remote_subscription	bridge	Action	☀️	📄
solace_bridge_remote_vpn	bridge	Action	☀️	📄
solace_bridge_tls_cn	bridge	Action	☀️	📄
solace_client	clientUsername	Action	☀️	📄
solace_client_profile	clientProfile	Action	☀️
solace_jndi	jndi	Action
solace_mqtt_session	mqttSession	Action
solace_queue	queue	Action	☀️	📄 📄
solace_subscription	queue/{..}/subscriptions	Action	☀️	📄
solace_topic	topicEndpoint	Action	☀️
solace_replay_log	replayLog	Action
solace_replicated_topic	replicatedTopic	Action
solace_rdp	restDeliveryPoint	Action	☀️	📄
solace_rdp_rest_consumer	restDeliveryPoint	Action	☀️	📄
solace_rdp_rest_consumer_trusted_common_name	restDeliveryPoint	Action	☀️	📄
solace_rdp_queue_binding	restDeliveryPoint	Action	☀️	📄
solace_vpn	msgVpn	Action	☀️	📄
solace_cert_authority	certAuthority	Action	☀️	📄
solace_dmr_bridge	dmrBridge	Action	☀️	📄
solace_dmr	dmrCluster	Action	☀️	📄
solace_link	dmrCluster	Action	☀️	📄
solace_link_remote_address	dmrCluster	Action	☀️	📄
solace_link_trusted_cn	dmrCluster	Action	☀️	📄

Writing New Modules

See Guide to Creating new Modules.

Open Issues

Open items to potentially enhance the framework. See Open Issues.

---

The End.