syntropynet / syntropynet.syntropy / 0.1.4 / module / syntropy_facts Gathers Syntropy Stack Facts | "added in version" 0.1.0 of syntropynet.syntropy" Authors: Andrius Mikonis (@foxis)syntropynet.syntropy.syntropy_facts (0.1.4) — module
Install with ansible-galaxy collection install syntropynet.syntropy:==0.1.4
collections: - name: syntropynet.syntropy version: 0.1.4
This module gathers facts about providers, api-keys, networks, connections, endpoints, topology.
- name: Retrieve all networks and all connections syntropy_facts: register: facts_output
- name: Retrieve api-keys syntropy_facts: gather_subset: ['api_keys']
- name: Retrieve topology syntropy_facts: endpoint_tags: ['dns', 'iot'] gather_subset: ['endpoints', 'networks', 'topology'] register: facts_subset_output
skip: default: 0 description: Skip N items in the fact list. type: int take: default: 42 description: Take N items in from the fact list. type: int api_url: default: null description: - URL Of the Platform API. - This parameter is required if SYNTROPY_API_SERVER environment variable is not set. required: false type: str api_token: default: null description: - API Authorization token string. - This parameter is required if SYNTROPY_API_TOKEN environment variable is not set. required: false type: str network_name: description: specifies network name to filter facts by. required: false type: str endpoint_name: description: specifies endpoint name to filter facts by. required: false type: str endpoint_tags: description: specifies endpoint tag to filter facts by. elements: str required: false type: list gather_subset: choices: - providers - api_keys - endpoints - networks - connections - topology default: - providers - networks - connections description: A subset of facts to gather. elements: str required: false type: list
error: description: Error message upon unsuccessful login. returned: always sample: Authorization failure type: str facts: contains: api_keys: description: A list of API Keys. elements: dict returned: When api_keys is present in gather_subset. type: list connections: description: A list of configured connections. elements: dict returned: When connections is present in gather_subset. type: list endpoints: description: A list of available endpoints. elements: dict returned: When endpoints is present in gather_subset. type: list networks: description: A list of configured networks. elements: dict returned: When networks is present in gather_subset. type: list providers: description: A list of endpoint providers. elements: dict returned: When providers is present in gather_subset. type: list topology: description: A list of network topology objects. elements: dict returned: When topology is present in gather_subset. type: list description: - Retrieved facts for various objects specified in gather_subset. - Please refer to the API documentation for more information on the returned facts. returned: always type: complex