# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Mikhail Yohman (@FragmentedPacket) <mikhail.yohman@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r"""
---
module: netbox_rack
short_description: Create, update or delete racks within NetBox
description:
- Creates, updates or removes racks from NetBox
notes:
- Tags should be defined as a YAML list
- This should be ran with connection C(local) and hosts C(localhost)
author:
- Mikhail Yohman (@FragmentedPacket)
requirements:
- pynetbox
version_added: '0.1.0'
extends_documentation_fragment:
- netbox.netbox.common
options:
data:
type: dict
description:
- Defines the rack configuration
suboptions:
name:
description:
- The name of the rack
required: true
type: str
facility_id:
description:
- The unique rack ID assigned by the facility
required: false
type: str
site:
description:
- Required if I(state=present) and the rack does not exist yet
required: false
type: raw
location:
description:
- The location the rack will be associated to (NetBox 2.11+)
required: false
type: raw
version_added: "3.1.0"
rack_group:
description:
- The rack group the rack will be associated to (NetBox < 2.11)
- Will be removed in version 5.0.0
required: false
type: raw
tenant:
description:
- The tenant that the device will be assigned to
required: false
type: raw
status:
description:
- The status of the rack
required: false
type: raw
rack_role:
description:
- The rack role the rack will be associated to
required: false
type: raw
serial:
description:
- Serial number of the rack
required: false
type: str
asset_tag:
description:
- Asset tag that is associated to the rack
required: false
type: str
type:
description:
- The type of rack
choices:
- 2-post frame
- 4-post frame
- 4-post cabinet
- Wall-mounted frame
- Wall-mounted cabinet
required: false
type: str
width:
description:
- The rail-to-rail width
choices:
- 10
- 19
- 21
- 23
required: false
type: int
u_height:
description:
- The height of the rack in rack units
required: false
type: int
desc_units:
description:
- Rack units will be numbered top-to-bottom
required: false
type: bool
outer_width:
description:
- The outer width of the rack
required: false
type: int
outer_depth:
description:
- The outer depth of the rack
required: false
type: int
outer_unit:
description:
- Whether the rack unit is in Millimeters or Inches and is I(required) if outer_width/outer_depth is specified
choices:
- Millimeters
- Inches
required: false
type: str
weight:
description:
- The weight of the rack
required: false
type: float
version_added: "3.10.0"
weight_unit:
description:
- The weight unit
choices:
- kg
- g
- lb
- oz
required: false
type: str
version_added: "3.10.0"
max_weight:
description:
- Maximum load capacity of the rack
required: false
type: int
version_added: "3.10.0"
mounting_depth:
description:
- The mounting depth of the rack
required: false
type: int
version_added: "3.10.0"
description:
description:
- Description of the rack
required: false
type: str
version_added: "3.10.0"
comments:
description:
- Comments that may include additional information in regards to the rack
required: false
type: str
tags:
description:
- Any tags that the rack may need to be associated with
required: false
type: list
elements: raw
custom_fields:
description:
- must exist in NetBox
required: false
type: dict
required: true
"""
EXAMPLES = r"""
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create rack within NetBox with only required information
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
state: present
- name: Create rack within NetBox with only required information - Pre 2.11
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
rack_group: Test Rack Group
state: present
- name: Create rack within NetBox with only required information - Post 2.11
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
location: Test Location
state: present
- name: Delete rack within netbox
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Rack
state: absent
"""
RETURN = r"""
rack:
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_RACKS,
)
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(
name=dict(required=True, type="str"),
facility_id=dict(required=False, type="str"),
site=dict(required=False, type="raw"),
location=dict(required=False, type="raw"),
rack_group=dict(
required=False,
type="raw",
removed_in_version="5.0.0",
removed_from_collection="netbox.netbox",
),
tenant=dict(required=False, type="raw"),
status=dict(required=False, type="raw"),
rack_role=dict(required=False, type="raw"),
serial=dict(required=False, type="str"),
asset_tag=dict(required=False, type="str"),
type=dict(
required=False,
type="str",
choices=[
"2-post frame",
"4-post frame",
"4-post cabinet",
"Wall-mounted frame",
"Wall-mounted cabinet",
],
),
width=dict(
required=False,
type="int",
choices=[
10,
19,
21,
23,
],
),
u_height=dict(required=False, type="int"),
desc_units=dict(required=False, type="bool"),
outer_width=dict(required=False, type="int"),
outer_depth=dict(required=False, type="int"),
outer_unit=dict(
required=False,
type="str",
choices=[
"Millimeters",
"Inches",
],
),
weight=dict(required=False, type="float"),
weight_unit=dict(
required=False,
type="str",
choices=[
"kg",
"g",
"lb",
"oz",
],
),
max_weight=dict(required=False, type="int"),
mounting_depth=dict(required=False, type="int"),
description=dict(required=False, type="str"),
comments=dict(required=False, type="str"),
tags=dict(required=False, type="list", elements="raw"),
custom_fields=dict(required=False, type="dict"),
),
),
)
)
required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
module = NetboxAnsibleModule(
argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
)
netbox_rack = NetboxDcimModule(module, NB_RACKS)
netbox_rack.run()
if __name__ == "__main__": # pragma: no cover
main()