.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. meta:: :antsibull-docs: 2.16.2 .. Anchors .. _ansible_collections.netbox.netbox.netbox_power_port_module: .. Anchors: short name for ansible.builtin .. Title netbox.netbox.netbox_power_port module -- Create, update or delete power ports within NetBox ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`netbox.netbox.netbox_power_port`. .. version_added .. rst-class:: ansible-version-added New in netbox.netbox 0.2.3 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Creates, updates or removes power ports from NetBox .. Aliases .. Requirements .. _ansible_collections.netbox.netbox.netbox_power_port_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - pynetbox .. Options Parameters ---------- .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-cert: .. rst-class:: ansible-option-title **cert** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`any` .. raw:: html
- .. raw:: html
Certificate path .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data: .. rst-class:: ansible-option-title **data** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Defines the power port configuration .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/allocated_draw: .. rst-class:: ansible-option-title **allocated_draw** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The allocated draw of the power port in watt .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Description of the power port .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/device: .. rst-class:: ansible-option-title **device** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The device the power port is attached to .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/label: .. rst-class:: ansible-option-title **label** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.18.0` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The label of the power port .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/maximum_draw: .. rst-class:: ansible-option-title **maximum_draw** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The maximum permissible draw of the power port in watt .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The name of the power port .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/tags: .. rst-class:: ansible-option-title **tags** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Any tags that the power port may need to be associated with .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
The type of the power port .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"iec-60320-c6"` - :ansible-option-choices-entry:`"iec-60320-c8"` - :ansible-option-choices-entry:`"iec-60320-c14"` - :ansible-option-choices-entry:`"iec-60320-c16"` - :ansible-option-choices-entry:`"iec-60320-c20"` - :ansible-option-choices-entry:`"iec-60320-c22"` - :ansible-option-choices-entry:`"iec-60309-p-n-e-4h"` - :ansible-option-choices-entry:`"iec-60309-p-n-e-6h"` - :ansible-option-choices-entry:`"iec-60309-p-n-e-9h"` - :ansible-option-choices-entry:`"iec-60309-2p-e-4h"` - :ansible-option-choices-entry:`"iec-60309-2p-e-6h"` - :ansible-option-choices-entry:`"iec-60309-2p-e-9h"` - :ansible-option-choices-entry:`"iec-60309-3p-e-4h"` - :ansible-option-choices-entry:`"iec-60309-3p-e-6h"` - :ansible-option-choices-entry:`"iec-60309-3p-e-9h"` - :ansible-option-choices-entry:`"iec-60309-3p-n-e-4h"` - :ansible-option-choices-entry:`"iec-60309-3p-n-e-6h"` - :ansible-option-choices-entry:`"iec-60309-3p-n-e-9h"` - :ansible-option-choices-entry:`"iec-60906-1"` - :ansible-option-choices-entry:`"nbr-14136-10a"` - :ansible-option-choices-entry:`"nbr-14136-20a"` - :ansible-option-choices-entry:`"nema-1-15p"` - :ansible-option-choices-entry:`"nema-5-15p"` - :ansible-option-choices-entry:`"nema-5-20p"` - :ansible-option-choices-entry:`"nema-5-30p"` - :ansible-option-choices-entry:`"nema-5-50p"` - :ansible-option-choices-entry:`"nema-6-15p"` - :ansible-option-choices-entry:`"nema-6-20p"` - :ansible-option-choices-entry:`"nema-6-30p"` - :ansible-option-choices-entry:`"nema-6-50p"` - :ansible-option-choices-entry:`"nema-10-30p"` - :ansible-option-choices-entry:`"nema-10-50p"` - :ansible-option-choices-entry:`"nema-14-20p"` - :ansible-option-choices-entry:`"nema-14-30p"` - :ansible-option-choices-entry:`"nema-14-50p"` - :ansible-option-choices-entry:`"nema-14-60p"` - :ansible-option-choices-entry:`"nema-15-15p"` - :ansible-option-choices-entry:`"nema-15-20p"` - :ansible-option-choices-entry:`"nema-15-30p"` - :ansible-option-choices-entry:`"nema-15-50p"` - :ansible-option-choices-entry:`"nema-15-60p"` - :ansible-option-choices-entry:`"nema-l1-15p"` - :ansible-option-choices-entry:`"nema-l5-15p"` - :ansible-option-choices-entry:`"nema-l5-20p"` - :ansible-option-choices-entry:`"nema-l5-30p"` - :ansible-option-choices-entry:`"nema-l5-50p"` - :ansible-option-choices-entry:`"nema-l6-15p"` - :ansible-option-choices-entry:`"nema-l6-20p"` - :ansible-option-choices-entry:`"nema-l6-30p"` - :ansible-option-choices-entry:`"nema-l6-50p"` - :ansible-option-choices-entry:`"nema-l10-30p"` - :ansible-option-choices-entry:`"nema-l14-20p"` - :ansible-option-choices-entry:`"nema-l14-30p"` - :ansible-option-choices-entry:`"nema-l14-50p"` - :ansible-option-choices-entry:`"nema-l14-60p"` - :ansible-option-choices-entry:`"nema-l15-20p"` - :ansible-option-choices-entry:`"nema-l15-30p"` - :ansible-option-choices-entry:`"nema-l15-50p"` - :ansible-option-choices-entry:`"nema-l15-60p"` - :ansible-option-choices-entry:`"nema-l21-20p"` - :ansible-option-choices-entry:`"nema-l21-30p"` - :ansible-option-choices-entry:`"nema-l22-30p"` - :ansible-option-choices-entry:`"cs6361c"` - :ansible-option-choices-entry:`"cs6365c"` - :ansible-option-choices-entry:`"cs8165c"` - :ansible-option-choices-entry:`"cs8265c"` - :ansible-option-choices-entry:`"cs8365c"` - :ansible-option-choices-entry:`"cs8465c"` - :ansible-option-choices-entry:`"ita-c"` - :ansible-option-choices-entry:`"ita-e"` - :ansible-option-choices-entry:`"ita-f"` - :ansible-option-choices-entry:`"ita-ef"` - :ansible-option-choices-entry:`"ita-g"` - :ansible-option-choices-entry:`"ita-h"` - :ansible-option-choices-entry:`"ita-i"` - :ansible-option-choices-entry:`"ita-j"` - :ansible-option-choices-entry:`"ita-k"` - :ansible-option-choices-entry:`"ita-l"` - :ansible-option-choices-entry:`"ita-m"` - :ansible-option-choices-entry:`"ita-n"` - :ansible-option-choices-entry:`"ita-o"` - :ansible-option-choices-entry:`"usb-a"` - :ansible-option-choices-entry:`"usb-b"` - :ansible-option-choices-entry:`"usb-c"` - :ansible-option-choices-entry:`"usb-mini-a"` - :ansible-option-choices-entry:`"usb-mini-b"` - :ansible-option-choices-entry:`"usb-micro-a"` - :ansible-option-choices-entry:`"usb-micro-b"` - :ansible-option-choices-entry:`"usb-micro-ab"` - :ansible-option-choices-entry:`"usb-3-b"` - :ansible-option-choices-entry:`"usb-3-micro-b"` - :ansible-option-choices-entry:`"dc-terminal"` - :ansible-option-choices-entry:`"saf-d-grid"` - :ansible-option-choices-entry:`"neutrik-powercon-20"` - :ansible-option-choices-entry:`"neutrik-powercon-32"` - :ansible-option-choices-entry:`"neutrik-powercon-true1"` - :ansible-option-choices-entry:`"neutrik-powercon-true1-top"` - :ansible-option-choices-entry:`"ubiquiti-smartpower"` - :ansible-option-choices-entry:`"hardwired"` - :ansible-option-choices-entry:`"other"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Dictionary of headers to be passed to the NetBox API. .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-netbox_token: .. rst-class:: ansible-option-title **netbox_token** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The NetBox API token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-netbox_url: .. rst-class:: ansible-option-title **netbox_url** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The URL of the NetBox instance. Must be accessible by the Ansible control host. .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-query_params: .. rst-class:: ansible-option-title **query_params** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state of the object. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"absent"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`any` .. raw:: html
- .. raw:: html
If :literal:`no`\ , SSL certificates will not be validated. 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` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - Tags should be defined as a YAML list - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: "Test NetBox modules" connection: local hosts: localhost gather_facts: false tasks: - name: Create power port within NetBox with only required information netbox.netbox.netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device state: present - name: Update power port with other fields netbox.netbox.netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device type: iec-60320-c6 allocated_draw: 16 maximum_draw: 80 description: power port description state: present - name: Delete power port within netbox netbox.netbox.netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device state: absent .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Key - Description * - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__return-msg: .. rst-class:: ansible-option-title **msg** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. raw:: html
* - .. raw:: html
.. _ansible_collections.netbox.netbox.netbox_power_port_module__return-power_port: .. rst-class:: ansible-option-title **power_port** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Tobias Groß (@toerb) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. 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 .. Parsing errors