.. Document meta :orphan: .. Anchors .. _ansible_collections.theforeman.foreman.subnet_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.subnet_info -- Fetch information about Subnets +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `theforeman.foreman collection `_ (version 2.1.2). To install it use: :code:`ansible-galaxy collection install theforeman.foreman`. To use it in a playbook, specify: :code:`theforeman.foreman.subnet_info`. .. version_added .. versionadded:: 2.1.0 of theforeman.foreman .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Fetch information about Subnets .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
location
string
Label of the Location to scope the search for.
name
string
Name of the resource to fetch information for.
Mutually exclusive with search.
organization
string
Name of the Organization to scope the search for.
password
string / required
Password of the user accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
search
string
Search query to use
If None, and name is not set, all resources are returned.
Mutually exclusive with name.
server_url
string / required
URL of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
username
string / required
Username accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to verify the TLS certificates of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead.

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: "Show a subnet" theforeman.foreman.subnet_info: username: "admin" password: "changeme" server_url: "https://foreman.example.com" name: "subnet.example.com" - name: "Show all subnets with domain example.com" theforeman.foreman.subnet_info: username: "admin" password: "changeme" server_url: "https://foreman.example.com" search: "domain = example.com" .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
subnet
dictionary
success and name was passed
Details about the found subnet

subnets
list / elements=dictionary
success and search was passed
List of all found subnets and their details



.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Evgeni Golov (@evgeni) .. Parsing errors