Fail on http errors

CHANGES.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 3.4.4
+
+- Add action parameter fail_non_2xx to allow the user to indicate if the
+  the action has failed when non-2xx http status codes are return by netbox.
+  The default value is False, which is to maintain the current pack behaviour.
+
+- Regenerated actions against v4.3 spec.
+
+- Applied Black code format to python code.
+
 ## 3.4.3
 
 - Enable use of encrypted KVs in pack config schema

actions/delete.circuits.circuit_group_assignments.yaml

@@ -0,0 +1,28 @@
+# This action was auto generated from the NetBox API Swagger Spec
+# NetBox API version: 4.3
+description: "Delete a Circuit group assignment object."
+enabled: true
+entry_point: run.py
+name: delete.circuits.circuit_group_assignments
+parameters:
+  endpoint_uri:
+    default: "/circuits/circuit-group-assignments/{{ id }}/"
+    immutable: true
+    type: string
+  http_verb:
+    default: delete
+    immutable: true
+    type: string
+  get_detail_route_eligible:
+    default: true
+    immutable: true
+    type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
+  id:
+    required: true
+    type: integer
+    description: "ID of the object to delete."
+runner_type: python-script

actions/delete.circuits.circuit_groups.yaml

@@ -0,0 +1,28 @@
+# This action was auto generated from the NetBox API Swagger Spec
+# NetBox API version: 4.3
+description: "Delete a circuit group object."
+enabled: true
+entry_point: run.py
+name: delete.circuits.circuit_groups
+parameters:
+  endpoint_uri:
+    default: "/circuits/circuit-groups/{{ id }}/"
+    immutable: true
+    type: string
+  http_verb:
+    default: delete
+    immutable: true
+    type: string
+  get_detail_route_eligible:
+    default: true
+    immutable: true
+    type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
+  id:
+    required: true
+    type: integer
+    description: "ID of the object to delete."
+runner_type: python-script

actions/delete.circuits.circuit_terminations.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a circuit termination object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.circuit_types.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a circuit type object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.circuits.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a circuit object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.provider_accounts.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a provider account object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.provider_networks.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a provider network object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.providers.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a provider object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.circuits.virtual_circuit_terminations.yaml

@@ -0,0 +1,28 @@
+# This action was auto generated from the NetBox API Swagger Spec
+# NetBox API version: 4.3
+description: "Delete a virtual circuit termination object."
+enabled: true
+entry_point: run.py
+name: delete.circuits.virtual_circuit_terminations
+parameters:
+  endpoint_uri:
+    default: "/circuits/virtual-circuit-terminations/{{ id }}/"
+    immutable: true
+    type: string
+  http_verb:
+    default: delete
+    immutable: true
+    type: string
+  get_detail_route_eligible:
+    default: true
+    immutable: true
+    type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
+  id:
+    required: true
+    type: integer
+    description: "ID of the object to delete."
+runner_type: python-script

actions/delete.circuits.virtual_circuit_types.yaml

@@ -0,0 +1,28 @@
+# This action was auto generated from the NetBox API Swagger Spec
+# NetBox API version: 4.3
+description: "Delete a virtual circuit type object."
+enabled: true
+entry_point: run.py
+name: delete.circuits.virtual_circuit_types
+parameters:
+  endpoint_uri:
+    default: "/circuits/virtual-circuit-types/{{ id }}/"
+    immutable: true
+    type: string
+  http_verb:
+    default: delete
+    immutable: true
+    type: string
+  get_detail_route_eligible:
+    default: true
+    immutable: true
+    type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
+  id:
+    required: true
+    type: integer
+    description: "ID of the object to delete."
+runner_type: python-script

actions/delete.circuits.virtual_circuits.yaml

@@ -0,0 +1,28 @@
+# This action was auto generated from the NetBox API Swagger Spec
+# NetBox API version: 4.3
+description: "Delete a virtual circuit object."
+enabled: true
+entry_point: run.py
+name: delete.circuits.virtual_circuits
+parameters:
+  endpoint_uri:
+    default: "/circuits/virtual-circuits/{{ id }}/"
+    immutable: true
+    type: string
+  http_verb:
+    default: delete
+    immutable: true
+    type: string
+  get_detail_route_eligible:
+    default: true
+    immutable: true
+    type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
+  id:
+    required: true
+    type: integer
+    description: "ID of the object to delete."
+runner_type: python-script

actions/delete.core.data_sources.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a data source object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.cable_terminations.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a cable termination object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.cables.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a cable object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.console_port_templates.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a console port template object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.console_ports.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a console port object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.console_server_port_templates.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a console server port template object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer

actions/delete.dcim.console_server_ports.yaml

@@ -1,5 +1,5 @@
 # This action was auto generated from the NetBox API Swagger Spec
-# NetBox API version: 4.0
+# NetBox API version: 4.3
 description: "Delete a console server port object."
 enabled: true
 entry_point: run.py
@@ -17,6 +17,10 @@ parameters:
     default: true
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   id:
     required: true
     type: integer