Facts

syntropynet.syntropy.syntropy_facts

Gathers facts about networks, connections, endpoints, topology from the Platform.
The output of this module is the dictionary of RAW API responses.

Parameter Choices/Defaults Comments
api_token
string
API Authorization token string.
This parameter is required if SYNTROPY_API_TOKEN environment variable is not set.
api_url
string
URL Of the Platform API.
This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
endpoint_name
string
specifies endpoint name to filter facts by.
endpoint_tags
list / elements=string
specifies endpoint tag to filter facts by.
gather_subset
list / elements=string
    Choices:
  • providers ←
  • api_keys
  • endpoints
  • connections ←
Default:
["providers", "connections"]
A subset of facts to gather.
skip
integer
Default:
0
Skip N items in the fact list.
take
integer
Default:
42
Take N items in from the fact list.


Did this page help you?