engine_facts - Facts about engines deployed in SMC

New in version 2.5.

Synopsis

  • Engines refers to any device that is deployed and managed by the Stonesoft Management Center. More specifically, an engine can be physical or virtual, an IPS, layer 2 firewall, layer 3 or clusters of these types.

Options

parameter required default choices comments
case_sensitive
 no True

Whether to do a case sensitive match on the filter specified
element
 no engine_clusters
  • engine_clusters
  • layer2_clusters
  • ips_clusters
  • fw_clusters

Type of engine to search for
exact_match
 no

Whether to do an exact match on the filter specified
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_ADDRESS
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_KEY Required if url
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_API_VERSION
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_DOMAIN
smc_extra_args
 no
Extra arguments to pass to login constructor. These are generally only used if specifically requested by support personnel.
Dictionary object smc_extra_args
parameter required default choices comments
verify
 no True
  • yes
  • no
Is the connection to SMC is HTTPS, you can set this to True, or provide a path to a client certificate to verify the SMC SSL certificate. You can also explicitly set this to False.
smc_logging
 no
Optionally enable SMC API logging to a file
Dictionary object smc_logging
parameter required default choices comments
path
 yes
Full path to the log file
level
 no
Log level as specified by the standard python logging library, in int format. Default setting is logging.DEBUG.
smc_timeout
 no

Optional timeout for connections to the SMC. Can be set through environment SMC_TIMEOUT

Examples

- name: Facts about all engines within SMC
  hosts: localhost
  gather_facts: no
  tasks:
  - name: Find all managed engines (IPS, Layer 2, L3FW)
    engine_facts:

  - name: Find a cluster FW named mycluster
    engine_facts:
      element: fw_clusters
      filter: mycluster

  - name: Find only Layer 2 FW's
    engine_facts:
      element: layer2_clusters

  - name: Find only IPS engines
    engine_facts:
      element: ips_clusters

  - name: Get engine details for 'myfirewall'
    engine_facts:
      filter: myfirewall

  - name: Get engine details for 'myfw' and save in editable YAML format
    register: results
    engine_facts:
      smc_logging:
        level: 10
        path: ansible-smc.log
      filter: newcluster
      as_yaml: true

  - name: Write the yaml using a jinja template
    template: src=templates/engine_yaml.j2 dest=./l3fw_cluster.yml

Return Values

Common return values are documented Return Values, the following are the fields unique to this module:

name description returned type sample
engines
When using a filter match, full engine json is returned
 always list [{'alias_value': [], 'allow_email_upn_lookup': False, 'auto_reboot_timeout': 10, 'antivirus': {'antivirus_update_day': 'mo', 'antivirus_http_proxy_enabled': False, 'antivirus_proxy_password': '*****', 'antivirus_proxy_port': 0, 'antivirus_enabled': False, 'virus_log_level': 'undefined', 'antivirus_update': 'never', 'antivirus_update_time': 0}, '...': None}]


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.

Author

  • David LePage (@gabstopper)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.