netbox.netbox.netbox_platform – Create or delete platforms within Netbox
Note
This plugin is part of the netbox.netbox collection (version 1.2.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_platform
.
New in version 0.1.0: of netbox.netbox
Synopsis
- Creates or removes platforms from Netbox
Requirements
The below requirements are needed on the host that executes this module.
- pynetbox
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required | Defines the platform configuration | ||
manufacturer raw | The manufacturer the platform will be tied to | ||
name string / required | The name of the platform | ||
napalm_args dictionary | The optional arguments used for NAPALM connections | ||
napalm_driver string | The name of the NAPALM driver to be used when using the NAPALM plugin | ||
slug string | The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided | ||
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
| Use present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create platform within Netbox with only required information netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform state: present - name: Create platform within Netbox with only required information netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform All manufacturer: Test Manufacturer napalm_driver: ios napalm_args: global_delay_factor: 2 state: present - name: Delete platform within netbox netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string | always | Message indicating failure or info about what has been achieved |
platform dictionary | success (when state=present) | Serialized object as created or already existent within Netbox |
Authors
- Mikhail Yohman (@FragmentedPacket)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netbox/netbox/netbox_platform_module.html