/ home / solace / solace.pubsub_plus / 1.0.0 / module / solace_client_profile

solace.pubsub_plus.solace_client_profile (1.0.0) — module

client profile

Authors: Mark Street (@mkst), Swen-Helge Huber (@ssh), Ricardo Gomez-Ulmke (@rjgu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install solace.pubsub_plus:==1.0.0

Add to requirements.yml

  collections:
    - name: solace.pubsub_plus
      version: 1.0.0

Description

Configure a Client Profile object. Allows addition, removal and configuration of Client Profile objects on Solace Brokers in an idempotent manner.

Supports Solace Cloud Brokers as well as Solace Standalone Brokers.

Inputs

    
host:
    default: localhost
    description: Hostname of Solace Broker.
    required: false
    type: str

name:
    aliases:
    - client_profile
    - client_profile_name
    description: Name of the client profile. Maps to 'clientProfileName' in the API.
    required: true
    type: str

port:
    default: 8080
    description: Management port of Solace Broker.
    required: false
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description: Target state.
    required: false
    type: str

msg_vpn:
    description: The message vpn.
    required: true
    type: str

timeout:
    default: 10
    description: Connection timeout in seconds for the http request.
    required: false
    type: int

password:
    default: admin
    description: Administrator password for Solace Broker.
    required: false
    type: str

settings:
    description: JSON dictionary of additional configuration, see Reference documentation.
    required: false
    type: dict

username:
    default: admin
    description: Administrator username for Solace Broker.
    required: false
    type: str

x_broker:
    description: Custom HTTP header with the broker virtual router id, if using a SEMPv2
      Proxy/agent infrastructure.
    required: false
    type: str

secure_connection:
    default: false
    description: If true, use https rather than http.
    required: false
    type: bool

solace_cloud_api_token:
    description:
    - The API Token.
    - Generate using Solace Cloud console with the appropriate permissions for the operations
      you want to enable.
    - Either both (solace_cloud_api_token AND solace_cloud_service_id) must be provided
      or none.
    required: false
    type: str

solace_cloud_service_id:
    description:
    - The service id in Solace Cloud.
    - Click on the service in Solace Cloud - the service id is in the URL.
    - Either both (solace_cloud_api_token AND solace_cloud_service_id) must be provided
      or none.
    required: false
    type: str

Outputs

response:
  description: The response from the Solace Sempv2 / Solace Cloud request.
  returned: success
  type: dict

Install collection

Add to requirements.yml

Description

Inputs

Outputs

See also