orphan: |
---|
netbox.netbox.netbox_virtual_disk module -- Creates or removes disks from virtual machines in NetBox
Note
This module is part of the netbox.netbox collection (version 3.17.0).
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 netbox.netbox
.
You need further requirements to be able to use this module,
see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_virtual_disk_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_virtual_disk
.
.. rst-class:: ansible-version-added
New in netbox.netbox 3.17.0
- Creates or removes disks from virtual machines in NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter | Comments |
---|---|
Certificate path |
|
Defines the vm disk configuration |
|
Must exist in NetBox |
|
The description of the disk |
|
Name of the disk to be created |
|
The size (in GB) of the disk |
|
Any tags that the virtual disk may need to be associated with |
|
Name of the virtual machine the disk will be associated with (case-sensitive) |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
- name: "Test NetBox virtual disk module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create virtual disk
netbox_virtual_disk:
data:
virtual_machine: test100
name: disk0
size: 50
state: present
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Key | Description |
---|---|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` on creation |
- Martin Rødvand (@rodvand)
.. ansible-links:: - title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true - title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true