FileMgr

✏️ /lib/python3.9/site-packages/ansible_collections/netbox/netbox/plugins/modules/netbox_ipam_role.py

✕ Tutup

# -*- coding: utf-8 -*-
# Copyright: (c) 2019, Mikhail Yohman (@FragmentedPacket)
# 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_ipam_role
short_description: Creates or removes ipam roles from NetBox
description:
  - Creates or removes ipam roles 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 ipam role configuration
    suboptions:
      name:
        description:
          - Name of the ipam role to be created
        required: true
        type: str
      slug:
        description:
          - The slugified version of the name or custom slug.
          - This is auto-generated following NetBox rules if not provided
        required: false
        type: str
      description:
        description:
          - The description of the ipam role
        required: false
        type: str
      weight:
        description:
          - The weight of the ipam role to be created
        required: false
        type: int
      tags:
        description:
          - The tags to add/update
        required: false
        type: list
        elements: raw
        version_added: "3.6.0"
      custom_fields:
        description:
          - Must exist in NetBox
        required: false
        type: dict
        version_added: "3.6.0"
    required: true
"""

EXAMPLES = r"""
- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create ipam role within NetBox with only required information
      netbox.netbox.netbox_ipam_role:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test IPAM Role
        state: present

- name: Delete ipam role within netbox
      netbox.netbox.netbox_ipam_role:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test IPAM Role
        state: absent
"""

RETURN = r"""
role:
  description: Serialized object as created or already existent within NetBox
  returned: on creation
  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_ipam import (
    NetboxIpamModule,
    NB_IPAM_ROLES,
)
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"),
                    slug=dict(required=False, type="str"),
                    description=dict(required=False, type="str"),
                    weight=dict(required=False, type="int"),
                    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_ipam_role = NetboxIpamModule(module, NB_IPAM_ROLES)
    netbox_ipam_role.run()

if __name__ == "__main__":  # pragma: no cover
    main()

Batal

⬅ plugins 78 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 __init__.py	py	0 B	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_aggregate.py	py	4.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_asn.py	py	3.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_cable.py	py	10.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_circuit.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_circuit_termination.py	py	5.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_circuit_type.py	py	3.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_cluster.py	py	5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_cluster_group.py	py	3.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_cluster_type.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_config_context.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_console_port.py	py	6.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_console_port_template.py	py	4.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_console_server_port.py	py	6.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_console_server_port_template.py	py	4.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_contact.py	py	5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_contact_group.py	py	3.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_contact_role.py	py	3.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_custom_field.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_custom_link.py	py	5.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device.py	py	9.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_bay.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_bay_template.py	py	3.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_interface.py	py	10.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_interface_template.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_role.py	py	4.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_device_type.py	py	7.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_export_template.py	py	4.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_fhrp_group.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_fhrp_group_assignment.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_front_port.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_front_port_template.py	py	5.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_inventory_item.py	py	6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_inventory_item_role.py	py	4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_ip_address.py	py	11.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_ipam_role.py	py	3.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_journal_entry.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_l2vpn.py	py	5.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_l2vpn_termination.py	py	4.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_location.py	py	4.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_manufacturer.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_module_type.py	py	5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_platform.py	py	4.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_feed.py	py	6.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_outlet.py	py	8.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_outlet_template.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_panel.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_port.py	py	8.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_power_port_template.py	py	7.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_prefix.py	py	8.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_provider.py	py	5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_provider_network.py	py	4.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rack.py	py	9.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rack_group.py	py	3.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rack_role.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rear_port.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rear_port_template.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_region.py	py	3.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_rir.py	py	4.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_route_target.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_service.py	py	5.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_service_template.py	py	4.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_site.py	py	7.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_site_group.py	py	4.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_tag.py	py	3.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_tenant.py	py	4.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_tenant_group.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_virtual_chassis.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_virtual_machine.py	py	7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_vlan.py	py	5.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_vlan_group.py	py	6.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_vm_interface.py	py	6.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_vrf.py	py	5.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_webhook.py	py	6.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_wireless_lan.py	py	5.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_wireless_lan_group.py	py	4.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 netbox_wireless_link.py	py	6.3 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission