job_button¶
Collection Note
This module is part of the networktocode.nautobot collection. To install the collection, use:
You need further requirements to be able to use this module, see the Requirements section for details.Synopsis¶
- Creates or removes job buttons from Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Data Type | Environment Variable | Comments |
---|---|---|---|
api_version | str | API Version Nautobot REST API Version Added: 4.1.0 |
|
button_class | str | Button class of this button Required if I(state=present) and the job button does not exist yet | |
confirmation | bool | Whether or not a confirmation pop-up box will appear | |
content_types | list | The content types to associate the job button with Required if I(state=present) and the job button does not exist yet | |
enabled | bool | Whether or not the button is enabled | |
group_name | str | Buttons in the same group will appear in a dropdown menu | |
job | raw | The job receiver to associate job with Required if I(state=present) and the job button does not exist yet | |
name required |
str | The name of the job button | |
query_params | list | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. Version Added: 3.0.0 |
|
state | str | Use C(present) or C(absent) for adding or removing. | |
text | str | The text to display on the button Required if I(state=present) and the job button does not exist yet | |
token required |
str | The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured. | |
url required |
str | The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured. | |
validate_certs | raw | If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured. | |
weight | int | Position this field should be displayed in |
Notes¶
Note
- This should be ran with connection C(local) and hosts C(localhost)
Examples¶
- name: Create job button within Nautobot with only required information
networktocode.nautobot.job_button:
url: http://nautobot.local
token: thisIsMyToken
name: MyJobButton
content_types:
- dcim.device
job: MyJob
text: SubmitMe
state: present
- name: Delete job button within Nautobot
networktocode.nautobot.job_button:
url: http://nautobot.local
token: thisIsMyToken
name: MyJobButton
state: absent
Return Values¶
Key | Data Type | Description | Returned |
---|---|---|---|
job_button | dict | Serialized object as created or already existent within Nautobot | success (when I(state=present)) |
msg | str | Message indicating failure or info about what has been achieved | always |
Authors¶
- Travis Smith (@tsm1th)