community.general.stacki_host – Add or remove host to stacki front-end
Note
This plugin is part of the community.general collection (version 3.8.1).
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 community.general.
To use it in a playbook, specify: community.general.stacki_host.
Synopsis
- Use this module to add or remove hosts to a stacki front-end via API.
- Information on stacki can be found at https://github.com/StackIQ/stacki.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| appliance
string
|
Default:
"backend"
|
Applicance to be used in host creation.
Required if state is present and host does not yet exist.
|
| force_install
boolean
|
|
Set value to true to force node into install state if it already exists in stacki.
|
| name
string / required
|
Name of the host to be added to Stacki.
|
|
| network
string
|
Default:
"private"
|
Network to be configured in the host.
Currently not used by the module.
|
| prim_intf
string
|
Name of the primary network interface.
Currently not used by the module.
|
|
| prim_intf_ip
string
|
IP Address for the primary network interface.
Currently not used by the module.
|
|
| prim_intf_mac
string
|
MAC Address for the primary PXE boot network interface.
Currently not used by the module.
|
|
| rack
integer
|
Rack to be used in host creation.
Required if state is present and host does not yet exist.
|
|
| rank
integer
|
Rank to be used in host creation.
In Stacki terminology, the rank is the position of the machine in a rack.
Required if state is present and host does not yet exist.
|
|
| stacki_endpoint
string / required
|
URL for the Stacki API Endpoint.
|
|
| stacki_password
string / required
|
Password for authenticating with Stacki API, but if not specified, the environment variable stacki_password is used instead.
|
|
| stacki_user
string / required
|
Username for authenticating with Stacki API, but if not specified, the environment variable stacki_user is used instead.
|
|
| state
string
|
|
Set value to the desired state for the specified host.
|
Examples
- name: Add a host named test-1
community.general.stacki_host:
name: test-1
stacki_user: usr
stacki_password: pwd
stacki_endpoint: url
prim_intf_mac: mac_addr
prim_intf_ip: x.x.x.x
prim_intf: eth0
- name: Remove a host named test-1
community.general.stacki_host:
name: test-1
stacki_user: usr
stacki_password: pwd
stacki_endpoint: url
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
boolean
|
always |
response to whether or not the api call completed successfully
Sample:
True
|
| stdout
list / elements=string
|
always |
the set of responses from the commands
Sample:
['...', '...']
|
| stdout_lines
list / elements=string
|
always |
the value of stdout split into a list
Sample:
[['...', '...'], ['...'], ['...']]
|
Authors
- Hugh Ma (@bbyhuy) <Hugh.Ma@flextronics.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/stacki_host_module.html