networktocode.nautobot.power_feed (5.1.1) — module

Install collection

Install with ansible-galaxy collection install networktocode.nautobot:==5.1.1

Add to requirements.yml

  collections:
    - name: networktocode.nautobot
      version: 5.1.1

Description

Creates, updates or removes power feeds from Nautobot

Requirements

• pynautobot

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create power feed within Nautobot with only required information
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        status: active
        state: present

    - name: Update power feed with other fields
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        status: offline
        type: primary
        supply: ac
        phase: single-phase
        voltage: 230
        amperage: 16
        max_utilization: 80
        comments: normal power feed
        state: present

    - name: Delete power feed within nautobot
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        state: absent

Inputs

    
url:
    description:
    - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)'
    required: true
    type: str

name:
    description:
    - The name of the power feed
    required: true
    type: str
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

rack:
    description:
    - The rack the power feed is assigned to
    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

type:
    choices:
    - primary
    - redundant
    description:
    - The type of the power feed
    required: false
    type: str
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

phase:
    choices:
    - single-phase
    - three-phase
    description:
    - The phase type of the power feed
    required: false
    type: str
    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

status:
    description:
    - The status of the power feed
    - Required if I(state=present) and does not exist yet
    required: false
    type: str
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

supply:
    choices:
    - ac
    - dc
    description:
    - The supply type of the power feed
    required: false
    type: str
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

voltage:
    description:
    - The voltage of the power feed
    required: false
    type: int
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

amperage:
    description:
    - The amperage of the power feed
    required: false
    type: int
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

comments:
    description:
    - Comments related to the power feed
    required: false
    type: str
    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

power_panel:
    description:
    - The power panel the power feed is terminated on
    required: true
    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

max_utilization:
    description:
    - The maximum permissible draw of the power feed in percent
    required: false
    type: int
    version_added: 3.0.0
    version_added_collection: networktocode.nautobot

Outputs

msg:
  description: Message indicating failure or info about what has been achieved
  returned: always
  type: str
power_feed:
  description: Serialized object as created or already existent within Nautobot
  returned: success (when I(state=present))
  type: dict