resource_info – Gather facts about resources¶
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
full_details
boolean
|
|
If
True all details about the found resources are returnedaliases: info |
organization
string
|
Scope the searched resource by organization
|
|
params
dictionary
|
Add parameters to the API call if necessary
If not specified, no additional parameters are passed
|
|
password
string
/ required
|
Password of the user accessing the Foreman server
|
|
resource
string
/ required
|
Resource to search
Set to an invalid choice like foo see all available options.
|
|
search
string
|
Search query to use
If None, all resources are returned
|
|
server_url
string
/ required
|
URL of the Foreman server
|
|
username
string
/ required
|
Username accessing the Foreman server
|
|
validate_certs
boolean
|
|
Whether or not to verify the TLS certificates of the Foreman server
|
Notes¶
Note
Some resources don’t support scoping and will return errors when you pass organization or unknown data in params.
Examples¶
- name: "Read a Setting"
resource_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
resource: settings
search: name = foreman_url
register: result
- debug:
var: result.resources[0].value
- name: "Read all Registries"
resource_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
resource: registries
register: result
- debug:
var: item.name
with_items: "{{ result.resources }}"
- name: "Read all Organizations with full details"
resource_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
resource: organizations
full_details: true
register: result
- debug:
var: result.resources
- name: Get all existing subscriptions for organization with id 1
resource_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
resource: subscriptions
params:
organization_id: 1
register: result
- debug:
var: result
- name: Get all existing activation keys for organization ACME
resource_info:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
resource: activation_keys
organization: ACME
register: result
- debug:
var: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
resources
list
|
always |
Resource information
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Sean O’Keeffe (@sean797)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.