Add new options for NetBox 3.4 (#905)

Author: rodvand

plugins/modules/netbox_aggregate.py

@@ -49,6 +49,12 @@
           - "The description of the aggregate"
         required: false
         type: str
+      comments:
+        description:
+          - Comments that may include additional information in regards to the aggregate
+        required: false
+        type: str
+        version_added: "3.10.0"
       tags:
         description:
           - "Any tags that the aggregate may need to be associated with"
@@ -138,6 +144,7 @@ def main():
                     rir=dict(required=False, type="raw"),
                     date_added=dict(required=False, type="str"),
                     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"),
                 ),

plugins/modules/netbox_cable.py

@@ -131,6 +131,18 @@
           - in
         required: false
         type: str
+      description:
+        description:
+          - Description of the provider
+        required: false
+        type: str
+        version_added: "3.10.0"
+      comments:
+        description:
+          - Comments related to the provider
+        required: false
+        type: str
+        version_added: "3.10.0"
       tags:
         description:
           - Any tags that the cable may need to be associated with
@@ -308,6 +320,8 @@ def main():
                     length_unit=dict(
                         required=False, choices=["m", "cm", "ft", "in"], type="str"
                     ),
+                    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"),
                 ),

plugins/modules/netbox_cluster.py

@@ -50,6 +50,12 @@
           - Required if I(state=present) and the cluster does not exist yet
         required: false
         type: raw
+      description:
+        description:
+          - The description of the cluster
+        required: false
+        type: str
+        version_added: "3.10.0"
       comments:
         description:
           - Comments that may include additional information in regards to the cluster
@@ -158,6 +164,7 @@ def main():
                     cluster_group=dict(required=False, type="raw"),
                     site=dict(required=False, type="raw"),
                     tenant=dict(required=False, type="raw"),
+                    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"),

plugins/modules/netbox_contact.py

@@ -54,6 +54,12 @@
           - The address of the contact
         required: false
         type: str
+      description:
+        description:
+          - The description of the contact
+        required: false
+        type: str
+        version_added: "3.10.0"
       comments:
         description:
           - Comments on the contact
@@ -69,7 +75,7 @@
           - URL associated with the contact
         required: false
         type: str
-        version_added: "3.7.0"
+        version_added: "3.7.0"    
       tags:
         description:
           - Any tags that the contact may need to be associated with
@@ -160,6 +166,7 @@ def main():
                     phone=dict(required=False, type="str"),
                     email=dict(required=False, type="str"),
                     address=dict(required=False, type="str"),
+                    description=dict(required=False, type="str"),
                     comments=dict(required=False, type="str"),
                     contact_group=dict(required=False, type="raw"),
                     link=dict(required=False, type="str"),

plugins/modules/netbox_custom_field.py

@@ -42,6 +42,7 @@
           - text
           - longtext
           - integer
+          - decimal
           - boolean
           - date
           - url
@@ -92,12 +93,28 @@
           - Fields with higher weights appear lower in a form
         required: false
         type: int
+      search_weight:
+        description:
+          - Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
+        required: false
+        type: int
+        version_added: "3.10.0"
       group_name:
         description:
           - The group to associate the custom field with
         required: false
         type: str      
         version_added: "3.10.0"
+      ui_visibility:
+         description:
+           - The UI visibility of the custom field
+         required: false
+         choices: 
+           - read-write
+           - read-only
+           - hidden
+         type: str      
+         version_added: "3.10.0"
       validation_minimum:
         description:
           - The minimum allowed value (for numeric fields)
@@ -144,7 +161,15 @@
         netbox_token: thisIsMyToken
         data:
           name: A Custom Field
-          required: yes          
+          required: yes    
+
+    - name: Update the custom field to make it read only
+      netbox.netbox.netbox_custom_field:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: A Custom Field
+          ui_visibility: read-only      
 
     - name: Delete the custom field
       netbox.netbox.netbox_custom_field:
@@ -195,6 +220,7 @@ def main():
                             "text",
                             "longtext",
                             "integer",
+                            "decimal",
                             "boolean",
                             "date",
                             "url",
@@ -214,7 +240,17 @@ def main():
                     filter_logic=dict(required=False, type="raw"),
                     default=dict(required=False, type="raw"),
                     weight=dict(required=False, type="int"),
+                    search_weight=dict(required=False, type="int"),
                     group_name=dict(required=False, type="str"),
+                    ui_visibility=dict(
+                        required=False,
+                        choices=[
+                            "read-write",
+                            "read-only",
+                            "hidden",
+                        ],
+                        type="str",
+                    ),
                     validation_minimum=dict(required=False, type="int"),
                     validation_maximum=dict(required=False, type="int"),
                     validation_regex=dict(required=False, type="str"),

plugins/modules/netbox_custom_link.py

@@ -33,7 +33,14 @@
         description:
           - The content type to apply this custom link to
         required: false
-        type: raw        
+        type: raw   
+      content_types:
+        description:
+          - The content type to apply this custom link to (NetBox 3.4+)
+        required: false
+        type: list
+        elements: raw 
+        version_added: "3.10.0"
       name: 
         description: 
           - The name of the custom link
@@ -139,6 +146,7 @@ def main():
                 required=True,
                 options=dict(
                     content_type=dict(required=False, type="raw"),
+                    content_types=dict(required=False, type="list", elements="raw"),
                     name=dict(required=True, type="str"),
                     link_text=dict(required=True, type="raw"),
                     link_url=dict(required=True, type="raw"),
@@ -153,12 +161,17 @@ def main():
     )
 
     required_if = [
-        ("state", "present", ["content_type", "name", "link_text", "link_url"]),
+        ("state", "present", ["name", "link_text", "link_url"]),
         ("state", "absent", ["name"]),
     ]
 
+    required_one_of = [("content_type", "content_types")]
+
     module = NetboxAnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
+        required_one_of=required_one_of,
     )
 
     netbox_custom_link = NetboxExtrasModule(module, NB_CUSTOM_LINKS)

plugins/modules/netbox_device.py

@@ -131,6 +131,12 @@
           - Priority in the assigned virtual chassis
         required: false
         type: int
+      description:
+        description:
+          - Description of the provider
+        required: false
+        type: str
+        version_added: "3.10.0"
       comments:
         description:
           - Comments that may include additional information in regards to the device
@@ -277,6 +283,7 @@ def main():
                     virtual_chassis=dict(required=False, type="raw"),
                     vc_position=dict(required=False, type="int"),
                     vc_priority=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"),
                     local_context_data=dict(required=False, type="dict"),

plugins/modules/netbox_device_type.py

@@ -55,6 +55,23 @@
           - The height of the device type in rack units
         required: false
         type: int
+      weight:
+        description:
+          - The weight of the device type
+        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"
       is_full_depth:
         description:
           - Whether or not the device consumes both front and rear rack faces
@@ -70,6 +87,12 @@
           - child
         required: false
         type: str
+      description:
+        description:
+          - Description of the provider
+        required: false
+        type: str
+        version_added: "3.10.0"
       comments:
         description:
           - Comments that may include additional information in regards to the device_type
@@ -168,12 +191,24 @@ def main():
                     slug=dict(required=False, type="str"),
                     part_number=dict(required=False, type="str"),
                     u_height=dict(required=False, type="int"),
+                    weight=dict(required=False, type="float"),
+                    weight_unit=dict(
+                        required=False,
+                        type="str",
+                        choices=[
+                            "kg",
+                            "g",
+                            "lb",
+                            "oz",
+                        ],
+                    ),
                     is_full_depth=dict(required=False, type="bool"),
                     subdevice_role=dict(
                         required=False,
                         choices=["Parent", "parent", "Child", "child"],
                         type="str",
                     ),
+                    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"),

plugins/modules/netbox_export_template.py

@@ -33,7 +33,14 @@
         description:
           - The content type to apply this export template to
         required: false
-        type: raw        
+        type: raw
+      content_types:
+        description:
+          - The content type to apply this export template to (NetBox 3.4+)
+        required: false
+        type: list
+        elements: raw 
+        version_added: "3.10.0"     
       name: 
         description: 
           - The name of the export template
@@ -128,6 +135,7 @@ def main():
                 required=True,
                 options=dict(
                     content_type=dict(required=False, type="raw"),
+                    content_types=dict(required=False, type="list", elements="raw"),
                     name=dict(required=True, type="str"),
                     description=dict(required=False, type="str"),
                     template_code=dict(required=True, type="raw"),
@@ -140,12 +148,17 @@ def main():
     )
 
     required_if = [
-        ("state", "present", ["content_type", "name", "template_code"]),
+        ("state", "present", ["name", "template_code"]),
         ("state", "absent", ["name"]),
     ]
 
+    required_one_of = [["content_type", "content_types"]]
+
     module = NetboxAnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
+        required_one_of=required_one_of,
     )
 
     netbox_export_template = NetboxExtrasModule(module, NB_EXPORT_TEMPLATES)

plugins/modules/netbox_ip_address.py

@@ -131,6 +131,12 @@
               - The virtual machine the interface is attached to.
             type: str
             required: False
+      comments:
+        description:
+          - Comments that may include additional information in regards to the IP Address
+        required: false
+        type: str
+        version_added: "3.10.0"
       tags:
         description:
           - Any tags that the IP address may need to be associated with
@@ -336,6 +342,7 @@ def main():
                             virtual_machine=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"),
                 ),

plugins/modules/netbox_l2vpn.py

@@ -61,6 +61,12 @@
           - The description of the L2VPN
         required: false
         type: str
+      comments:
+        description:
+          - Comments that may include additional information in regards to the L2VPN
+        required: false
+        type: str
+        version_added: "3.10.0"
       tenant:
         description:
           - The tenant that the L2VPN will be assigned to
@@ -163,6 +169,7 @@ def main():
                     import_targets=dict(required=False, type="list", elements="raw"),
                     export_targets=dict(required=False, type="list", elements="raw"),
                     description=dict(required=False, type="str"),
+                    comments=dict(required=False, type="str"),
                     tenant=dict(required=False, type="raw"),
                     tags=dict(required=False, type="list", elements="raw"),
                     custom_fields=dict(required=False, type="dict"),