solace.pubsub_plus.solace_get_facts (1.0.0) — module

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

Provides convenience functions to access solace facts retrieved from broker service using M(solace_gather_facts) from 'ansible_facts.solace'.

Inputs

    
host:
    description: The playbook host to retrieve the facts from.
    required: true
    type: str

fields:
    default: []
    description: 'List of field names to retrieve from hostvars. Note: Retrieves the first
      occurrence of the field name only.'
    elements: str
    required: false
    type: list

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

hostvars:
    description: The playbook's 'hostvars'.
    required: true
    type: dict

field_funcs:
    default: []
    description: List of pre-built field functions that retrieve values from hostvars.
    elements: str
    required: false
    suboptions:
      get_allClientConnectionDetails:
        description:
        - Retrieve all enabled client connection details for the various protocols for
          the service/broker.
        required: false
        type: str
      get_bridge_remoteMsgVpnLocations:
        description:
        - Retrieve enabled remote message vpn locations (plain, secured, compressed) for
          the service/broker.
        - 'For Solace Cloud: {hostname}:{port}.'
        - 'For broker: v:{virtualRouterName}.'
        required: false
        type: str
      get_serviceSMFMessagingEndpoints:
        description: Retrieve the all smf messaging endpoints
        required: false
        type: str
      get_serviceSmfCompressionListenPort:
        description: Retrieve the smf compressed listen port
        required: false
        type: str
      get_serviceSmfPlainTextListenPort:
        description: Retrieve the smf plain listen port
        required: false
        type: str
      get_serviceSmfTlsListenPort:
        description: Retrieve the smf tls listen port
        required: false
        type: str
      get_virtualRouterName:
        description: Retrieve the virtual router name
        required: false
        type: str
    type: list

Outputs

facts:
  description: The facts requested.
  elements: dict
  returned: success
  sample:
    facts:
      serviceSmfCompressionListenPort: 55003
      serviceSmfPlainTextListenPort: 55555
      serviceSmfTlsListenPort: 55443
      virtualRouterName: single-aws-eu-west-6e-4ftdf
  type: dict

See also

• solace_gather_facts