theforeman.foreman.subnet_info – Fetch information about Subnets

Note

This plugin is part of the theforeman.foreman collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.subnet_info.

New in version 2.1.0: of theforeman.foreman

Synopsis

  • Fetch information about Subnets

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

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.

Examples

- 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"

Return Values

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

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



Authors

  • Evgeni Golov (@evgeni)