Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,23 @@ hostname: "netbox.corp.lan"
api_token: "aaabbbccc111222333"
use_https: true
ssl_verify: true
default_fail_non_2xx: false # Optional: when true, actions fail on non-2xx NetBox responses by default
```

After editing, run `sudo st2ctl reload --register-configs` to ensure your configuration
is loaded.

### Controlling action failure on non-2xx responses

By default, NetBox actions in this pack **do not** fail when NetBox returns a non-2xx HTTP status unless the `fail_non_2xx` action parameter is explicitly set to `true`.

- The pack configuration option `default_fail_non_2xx` controls the **default** behavior for all NetBox HTTP actions:
- If `default_fail_non_2xx` is `false` or omitted (the default), actions will only fail on non-2xx responses when `fail_non_2xx=true` is explicitly set on the action invocation.
- If `default_fail_non_2xx` is `true`, actions will fail on non-2xx responses **by default**, unless explicitly overridden.
- The per-action parameter `fail_non_2xx` always takes precedence over the pack config:
- `fail_non_2xx=true` forces the action to fail on non-2xx responses, regardless of `default_fail_non_2xx`.
- `fail_non_2xx=false` forces the action **not** to fail on non-2xx responses, even if `default_fail_non_2xx` is `true`.

## Actions

There are more than 290 actions in this pack. Each maps to a particular NetBox API endpoint.
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.circuit_group_assignments.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.circuit_groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.circuit_terminations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.circuit_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.circuits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.provider_accounts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.provider_networks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.virtual_circuit_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.circuits.virtual_circuits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.core.data_sources.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.cable_terminations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.cables.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.console_port_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.console_ports.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.console_server_port_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.console_server_ports.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.device_bay_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.device_bays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.device_roles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.device_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.devices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.front_port_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.front_ports.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.interface_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.interfaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.inventory_item_roles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.inventory_item_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.inventory_items.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.locations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.mac_addresses.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.manufacturers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.module_bay_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.module_bays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.module_type_profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.module_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.modules.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.platforms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_feeds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_outlet_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_outlets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_panels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_port_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.power_ports.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.rack_reservations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
1 change: 0 additions & 1 deletion actions/delete.dcim.rack_roles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ parameters:
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:
Expand Down
Loading
Loading