engine_routing_facts - Facts about specific routes configured on an NGFW Engine¶
Synopsis¶
Show the current routing table for the given engine. This will show references to the dst_if for the route along with the gateway and route network. Use engine_facts to resolve interface ID’s returned by this module.
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 |
||||||||||||||||
| exact_match |
no |
Whether to do an exact match on the filter specified |
|||||||||||||||||
| filter |
yes |
Specify the name of the engine in order to find the routing table |
|||||||||||||||||
| 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, address 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 SMC API version to connect to. If none is provided, the latest long-term support (LTS) version of the SMC API will be used based on the SMC version. Can be set though the environment variable |
|||||||||||||||||
| smc_domain |
no |
Optional administrative domain in the SMC to log on to. If no domain is provided, 'Shared Domain' is used. Can be set through the environment variable |
|||||||||||||||||
| smc_extra_args |
no |
Extra arguments to pass to the login constructor. These arguments 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 API. Can be set through the environment variable |
|||||||||||||||||
Return Values¶
Return values that are common to all modules are documented in Return Values. The following fields are unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| routes |
Return all engine routes
|
always | list | [{'route_network': '0.0.0.0', 'route_gateway': '10.0.0.1', 'src_if': -1, 'route_type': 'Static', 'route_netmask': 0, 'dst_if': 1}, {'route_network': '0.0.0.0', 'route_gateway': '172.18.1.240', 'src_if': -1, 'route_type': 'Static', 'route_netmask': 0, 'dst_if': 0}, {'route_network': '10.0.0.0', 'route_gateway': None, 'src_if': -1, 'route_type': 'Connected', 'route_netmask': 24, 'dst_if': 1}] |
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.
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.