| Server IP : 85.214.239.14 / Your IP : 18.116.27.78 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /lib/python3/dist-packages/ansible_collections/netbox/netbox/plugins/modules/ |
Upload File : |
#!/usr/bin/python
# -*- coding: utf-8 -*-
# © 2020 Nokia
# Licensed under the GNU General Public License v3.0 only
# SPDX-License-Identifier: GPL-3.0-only
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r"""
---
module: netbox_power_outlet
short_description: Create, update or delete power outlets within NetBox
description:
- Creates, updates or removes power outlets from NetBox
notes:
- Tags should be defined as a YAML list
- This should be ran with connection C(local) and hosts C(localhost)
author:
- Tobias Groß (@toerb)
requirements:
- pynetbox
version_added: '0.2.3'
extends_documentation_fragment:
- netbox.netbox.common
options:
data:
type: dict
required: true
description:
- Defines the power outlet configuration
suboptions:
device:
description:
- The device the power outlet is attached to
required: true
type: raw
name:
description:
- The name of the power outlet
required: true
type: str
type:
description:
- The type of the power outlet
choices:
- iec-60320-c5
- iec-60320-c7
- iec-60320-c13
- iec-60320-c15
- iec-60320-c19
- iec-60309-p-n-e-4h
- iec-60309-p-n-e-6h
- iec-60309-p-n-e-9h
- iec-60309-2p-e-4h
- iec-60309-2p-e-6h
- iec-60309-2p-e-9h
- iec-60309-3p-e-4h
- iec-60309-3p-e-6h
- iec-60309-3p-e-9h
- iec-60309-3p-n-e-4h
- iec-60309-3p-n-e-6h
- iec-60309-3p-n-e-9h
- nema-5-15r
- nema-5-20r
- nema-5-30r
- nema-5-50r
- nema-6-15r
- nema-6-20r
- nema-6-30r
- nema-6-50r
- nema-l5-15r
- nema-l5-20r
- nema-l5-30r
- nema-l5-50r
- nema-l6-20r
- nema-l6-30r
- nema-l6-50r
- nema-l14-20r
- nema-l14-30r
- nema-l21-20r
- nema-l21-30r
- CS6360C
- CS6364C
- CS8164C
- CS8264C
- CS8364C
- CS8464C
- ita-e
- ita-f
- ita-g
- ita-h
- ita-i
- ita-j
- ita-k
- ita-l
- ita-m
- ita-n
- ita-o
- hdot-cx
required: false
type: str
power_port:
description:
- The attached power port
required: false
type: raw
feed_leg:
description:
- The phase, in case of three-phase feed
choices:
- A
- B
- C
required: false
type: str
description:
description:
- Description of the power outlet
required: false
type: str
tags:
description:
- Any tags that the power outlet may need to be associated with
required: false
type: list
elements: raw
"""
EXAMPLES = r"""
- 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_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
state: present
- name: Update power port with other fields
netbox.netbox.netbox_power_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
type: iec-60320-c6
power_port: Test Power Port
feed_leg: A
description: power port description
state: present
- name: Delete power port within netbox
netbox.netbox.netbox_power_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
state: absent
"""
RETURN = r"""
power_outlet:
description: Serialized object as created or already existent within NetBox
returned: success (when I(state=present))
type: dict
msg:
description: Message indicating failure or info about what has been achieved
returned: always
type: str
"""
from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
NetboxAnsibleModule,
NETBOX_ARG_SPEC,
)
from ansible_collections.netbox.netbox.plugins.module_utils.netbox_dcim import (
NetboxDcimModule,
NB_POWER_OUTLETS,
)
from copy import deepcopy
def main():
"""
Main entry point for module execution
"""
argument_spec = deepcopy(NETBOX_ARG_SPEC)
argument_spec.update(
dict(
data=dict(
type="dict",
required=True,
options=dict(
device=dict(required=True, type="raw"),
name=dict(required=True, type="str"),
type=dict(
required=False,
choices=[
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c19",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l21-20r",
"nema-l21-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"hdot-cx",
],
type="str",
),
power_port=dict(required=False, type="raw"),
feed_leg=dict(required=False, choices=["A", "B", "C"], type="str"),
description=dict(required=False, type="str"),
tags=dict(required=False, type="list", elements="raw"),
),
),
)
)
required_if = [
("state", "present", ["device", "name"]),
("state", "absent", ["device", "name"]),
]
module = NetboxAnsibleModule(
argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
)
netbox_power_outlet = NetboxDcimModule(module, NB_POWER_OUTLETS)
netbox_power_outlet.run()
if __name__ == "__main__": # pragma: no cover
main()