network_element_facts - Facts about networks elements in the SMC¶
New in version 2.5.
Synopsis¶
- Network elements can be used as references in many areas of the configuration. This fact module provides the ability to retrieve information related to elements and their values.
Requirements (on host that executes module)¶
- smc-python
Options¶
| parameter | required | default | choices | comments | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| case_sensitive |
no | True |
Whether to do a case sensitive match on the filter specified |
||||||||||||||||
| element |
no | * |
|
Type of network element to retrieve |
|||||||||||||||
| exact_match |
no |
Whether to do an exact match on the filter specified |
|||||||||||||||||
| expand |
no |
|
Optionally expand element attributes that contain only href |
||||||||||||||||
| filter |
no | * |
String value to match against when making query. Matches all if not specified. A filter will attempt to find a match in the name, primary key field or comment field of a given record. |
||||||||||||||||
| limit |
no | 10 |
Limit the number of results. Set to 0 to remove limit. |
||||||||||||||||
| smc_address |
no |
FQDN with port of SMC. The default value is the environment variable |
|||||||||||||||||
| smc_alt_filepath |
no |
Provide an alternate path location to read the credentials from. File is expected to be stored in ~.smcrc. If provided, url and api_key settings are not required and will be ignored. |
|||||||||||||||||
| smc_api_key |
no |
API key for api client. The default value is the environment variable |
|||||||||||||||||
| smc_api_version |
no |
Optional API version to connect to. If none is provided, the latest SMC version API will be used based on the Management Center version. Can be set though the environment variable |
|||||||||||||||||
| smc_domain |
no |
Optional domain to log in to. If no domain is provided, 'Shared Domain' is used. Can be set throuh the environment variable |
|||||||||||||||||
| smc_extra_args |
no |
Extra arguments to pass to login constructor. These are generally only used if specifically requested by support personnel.
| |||||||||||||||||
|
|||||||||||||||||||
| smc_logging |
no |
Optionally enable SMC API logging to a file
| |||||||||||||||||
|
|||||||||||||||||||
| smc_timeout |
no |
Optional timeout for connections to the SMC. Can be set through environment |
|||||||||||||||||
Examples¶
- name: All network elements, limit result to 10
network_element_facts:
limit: 10
- name: Find all hosts with an IP value of 1.1.1.1
network_element_facts:
limit: 0
element: host
filter: 1.1.1.1
- name: Find an address range including 1.1.1.1
network_element_facts:
limit: 10
element: address_range
filter: 1.1.1.1
- name: Find a specific group and expand all members
network_element_facts:
element: group
filter: mygroup
expand:
- group
Return Values¶
Common return values are documented Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| elements |
Return from all elements using filter of '10.'
|
always | list | [{'comment': None, 'ipv6_network': '::/0', 'ipv4_network': '0.0.0.0/0', 'type': 'network', 'name': 'Any network'}, {'type': 'single_fw', 'name': 'myfirewall'}, {'comment': None, 'ipv6_network': None, 'ipv4_network': '10.0.0.0/8', 'type': 'network', 'name': 'private-10.0.0.0/8'}, {'comment': None, 'ipv6_network': None, 'ipv4_network': '10.10.10.0/24', 'type': 'network', 'name': 'network-10.10.10.0/24'}] |
Notes¶
Note
- If a filter is not used in the query, this will return all results for the element type specified. The return data in this case will only contain the metadata for the element which will be name and type. To get detailed information about an element, use a filter. When using filters on network or service elements, the filter value will search the element fields, for example, you could use a filter of ‘1.1.1.1’ when searching for hosts and all hosts with this IP will be returned. The same applies for services. If you are unsure of the service name but know the port you require, your filter can be by port.