networktocode / networktocode.nautobot / 4.5.0 / module / virtual_machine Create, update or delete virtual_machines within Nautobot | "added in version" 1.0.0 of networktocode.nautobot" Authors: Gaelle MANGIN (@gmangin)networktocode.nautobot.virtual_machine (4.5.0) — module
Install with ansible-galaxy collection install networktocode.nautobot:==4.5.0
collections: - name: networktocode.nautobot version: 4.5.0
Creates, updates or removes virtual_machines from Nautobot
- name: "Test Nautobot modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create virtual machine within Nautobot with only required information networktocode.nautobot.virtual_machine: url: http://nautobot.local token: thisIsMyToken name: Test Virtual Machine cluster: test cluster status: active state: present - name: Delete virtual machine within nautobot networktocode.nautobot.virtual_machine: url: http://nautobot.local token: thisIsMyToken name: Test Virtual Machine state: absent - name: Create virtual machine with tags networktocode.nautobot.virtual_machine: url: http://nautobot.local token: thisIsMyToken name: Another Test Virtual Machine cluster: test cluster site: Test Site status: active tags: - Schnozzberry state: present - name: Update vcpus, memory and disk of an existing virtual machine networktocode.nautobot.virtual_machine: url: http://nautobot.local token: thisIsMyToken name: Test Virtual Machine cluster: test cluster vcpus: 8 memory: 8 disk: 8 state: present
url: description: - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)' required: true type: str disk: description: - Disk of the virtual machine (GB) required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot name: description: - The name of the virtual machine required: true type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot site: description: - The name of the site attach to the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot tags: description: - Any tags that this item may need to be associated with elements: raw required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot state: choices: - absent - present default: present description: - Use C(present) or C(absent) for adding or removing. type: str token: description: - The token created within Nautobot to authorize API access required: true type: str vcpus: description: - Number of vcpus of the virtual machine required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot memory: description: - Memory of the virtual machine (MB) required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot status: description: - The status of the virtual machine - Required if I(state=present) and does not exist yet required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot tenant: description: - The tenant that the virtual machine will be assigned to required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot cluster: description: - The name of the cluster attach to the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot comments: description: - Comments of the virtual machine required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot platform: description: - The platform of the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot api_version: description: - API Version Nautobot REST API required: false type: str version_added: 4.1.0 version_added_collection: networktocode.nautobot primary_ip4: description: - Primary IPv4 address assigned to the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot primary_ip6: description: - Primary IPv6 address assigned to the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot query_params: description: - 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. elements: str required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot custom_fields: description: - Must exist in Nautobot and in key/value format required: false type: dict version_added: 3.0.0 version_added_collection: networktocode.nautobot validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: raw local_context_data: description: - configuration context of the virtual machine required: false type: dict version_added: 3.0.0 version_added_collection: networktocode.nautobot virtual_machine_role: description: - The role of the virtual machine required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot
msg: description: Message indicating failure or info about what has been achieved returned: always type: str virtual machine: description: Serialized object as created or already existent within Nautobot returned: success (when I(state=present)) type: dict