get.dcim.power_outlets.yaml

# This action was auto generated from the NetBox API Swagger Spec
# NetBox API version: 4.0
description: "Get a list of power outlet objects."
enabled: true
entry_point: run.py
name: get.dcim.power_outlets
parameters:
  endpoint_uri:
    default: "/dcim/power-outlets/"
    immutable: true
    type: string
  http_verb:
    default: get
    immutable: true
    type: string
  get_detail_route_eligible:
    default: true
    immutable: true
    type: boolean
  cable_end:
    required: false
    type: string
    description: "* `A` - A
* `B` - B"
  cable_end__n:
    required: false
    type: string
    description: "Cable_end not equal to"
  cable_id:
    required: false
    type: array
    description: "Cable (ID)"
  cable_id__n:
    required: false
    type: array
    description: "Cable_id not equal to"
  cabled:
    required: false
    type: boolean
    description: "Cabled"
  connected:
    required: false
    type: boolean
    description: "Connected"
  created:
    required: false
    type: array
    description: "Created"
  created__empty:
    required: false
    type: array
    description: "Created is empty/null (boolean)"
  created__gt:
    required: false
    type: array
    description: "Created greater than"
  created__gte:
    required: false
    type: array
    description: "Created greater than or equal to"
  created__lt:
    required: false
    type: array
    description: "Created less than"
  created__lte:
    required: false
    type: array
    description: "Created less than or equal to"
  created__n:
    required: false
    type: array
    description: "Created not equal to"
  created_by_request:
    required: false
    type: string
    description: "Created_by_request"
  description:
    required: false
    type: array
    description: "Description"
  description__empty:
    required: false
    type: boolean
    description: "Description is empty/null (boolean)"
  description__ic:
    required: false
    type: array
    description: "Description contains (case-insensitive)"
  description__ie:
    required: false
    type: array
    description: "Description exact match (case-insensitive)"
  description__iew:
    required: false
    type: array
    description: "Description ends with (case-insensitive)"
  description__isw:
    required: false
    type: array
    description: "Description starts with (case-sensitive)"
  description__n:
    required: false
    type: array
    description: "Description not equal to"
  description__nic:
    required: false
    type: array
    description: "Description does not contain (case-insensitive)"
  description__nie:
    required: false
    type: array
    description: "Description inverse exact match (case-insensitive)"
  description__niew:
    required: false
    type: array
    description: "Description does not end with (case-insensitive)"
  description__nisw:
    required: false
    type: array
    description: "Description does not start with (case-sensitive)"
  device:
    required: false
    type: array
    description: "Device (name)"
  device__n:
    required: false
    type: array
    description: "Device not equal to"
  device_id:
    required: false
    type: array
    description: "Device (ID)"
  device_id__n:
    required: false
    type: array
    description: "Device_id not equal to"
  device_type:
    required: false
    type: array
    description: "Device type (model)"
  device_type__n:
    required: false
    type: array
    description: "Device_type not equal to"
  device_type_id:
    required: false
    type: array
    description: "Device type (ID)"
  device_type_id__n:
    required: false
    type: array
    description: "Device_type_id not equal to"
  feed_leg:
    required: false
    type: array
    description: "Phase (for three-phase feeds)"
  feed_leg__n:
    required: false
    type: array
    description: "Feed_leg not equal to"
  id:
    required: false
    type: array
    description: "Id"
  id__empty:
    required: false
    type: boolean
    description: "Id is empty/null (boolean)"
  id__gt:
    required: false
    type: array
    description: "Id greater than"
  id__gte:
    required: false
    type: array
    description: "Id greater than or equal to"
  id__lt:
    required: false
    type: array
    description: "Id less than"
  id__lte:
    required: false
    type: array
    description: "Id less than or equal to"
  id__n:
    required: false
    type: array
    description: "Id not equal to"
  label:
    required: false
    type: array
    description: "Label"
  label__empty:
    required: false
    type: boolean
    description: "Label is empty/null (boolean)"
  label__ic:
    required: false
    type: array
    description: "Label contains (case-insensitive)"
  label__ie:
    required: false
    type: array
    description: "Label exact match (case-insensitive)"
  label__iew:
    required: false
    type: array
    description: "Label ends with (case-insensitive)"
  label__isw:
    required: false
    type: array
    description: "Label starts with (case-sensitive)"
  label__n:
    required: false
    type: array
    description: "Label not equal to"
  label__nic:
    required: false
    type: array
    description: "Label does not contain (case-insensitive)"
  label__nie:
    required: false
    type: array
    description: "Label inverse exact match (case-insensitive)"
  label__niew:
    required: false
    type: array
    description: "Label does not end with (case-insensitive)"
  label__nisw:
    required: false
    type: array
    description: "Label does not start with (case-sensitive)"
  last_updated:
    required: false
    type: array
    description: "Last_updated"
  last_updated__empty:
    required: false
    type: array
    description: "Last_updated is empty/null (boolean)"
  last_updated__gt:
    required: false
    type: array
    description: "Last_updated greater than"
  last_updated__gte:
    required: false
    type: array
    description: "Last_updated greater than or equal to"
  last_updated__lt:
    required: false
    type: array
    description: "Last_updated less than"
  last_updated__lte:
    required: false
    type: array
    description: "Last_updated less than or equal to"
  last_updated__n:
    required: false
    type: array
    description: "Last_updated not equal to"
  limit:
    required: false
    type: integer
    description: "Number of results to return per page."
  location:
    required: false
    type: array
    description: "Location (slug)"
  location__n:
    required: false
    type: array
    description: "Location not equal to"
  location_id:
    required: false
    type: array
    description: "Location (ID)"
  location_id__n:
    required: false
    type: array
    description: "Location_id not equal to"
  mark_connected:
    required: false
    type: boolean
    description: "Mark_connected"
  modified_by_request:
    required: false
    type: string
    description: "Modified_by_request"
  module_id:
    required: false
    type: array
    description: "Module (ID)"
  module_id__n:
    required: false
    type: array
    description: "Module_id not equal to"
  name:
    required: false
    type: array
    description: "Name"
  name__empty:
    required: false
    type: boolean
    description: "Name is empty/null (boolean)"
  name__ic:
    required: false
    type: array
    description: "Name contains (case-insensitive)"
  name__ie:
    required: false
    type: array
    description: "Name exact match (case-insensitive)"
  name__iew:
    required: false
    type: array
    description: "Name ends with (case-insensitive)"
  name__isw:
    required: false
    type: array
    description: "Name starts with (case-sensitive)"
  name__n:
    required: false
    type: array
    description: "Name not equal to"
  name__nic:
    required: false
    type: array
    description: "Name does not contain (case-insensitive)"
  name__nie:
    required: false
    type: array
    description: "Name inverse exact match (case-insensitive)"
  name__niew:
    required: false
    type: array
    description: "Name does not end with (case-insensitive)"
  name__nisw:
    required: false
    type: array
    description: "Name does not start with (case-sensitive)"
  occupied:
    required: false
    type: boolean
    description: "Occupied"
  offset:
    required: false
    type: integer
    description: "The initial index from which to return the results."
  ordering:
    required: false
    type: string
    description: "Which field to use when ordering the results."
  power_port_id:
    required: false
    type: array
    description: "Power port (ID)"
  power_port_id__n:
    required: false
    type: array
    description: "Power_port_id not equal to"
  q:
    required: false
    type: string
    description: "Search"
  rack:
    required: false
    type: array
    description: "Rack (name)"
  rack__n:
    required: false
    type: array
    description: "Rack not equal to"
  rack_id:
    required: false
    type: array
    description: "Rack (ID)"
  rack_id__n:
    required: false
    type: array
    description: "Rack_id not equal to"
  region:
    required: false
    type: array
    description: "Region (slug)"
  region__n:
    required: false
    type: array
    description: "Region not equal to"
  region_id:
    required: false
    type: array
    description: "Region (ID)"
  region_id__n:
    required: false
    type: array
    description: "Region_id not equal to"
  role:
    required: false
    type: array
    description: "Device role (slug)"
  role__n:
    required: false
    type: array
    description: "Role not equal to"
  role_id:
    required: false
    type: array
    description: "Device role (ID)"
  role_id__n:
    required: false
    type: array
    description: "Role_id not equal to"
  site:
    required: false
    type: array
    description: "Site name (slug)"
  site__n:
    required: false
    type: array
    description: "Site not equal to"
  site_group:
    required: false
    type: array
    description: "Site group (slug)"
  site_group__n:
    required: false
    type: array
    description: "Site_group not equal to"
  site_group_id:
    required: false
    type: array
    description: "Site group (ID)"
  site_group_id__n:
    required: false
    type: array
    description: "Site_group_id not equal to"
  site_id:
    required: false
    type: array
    description: "Site (ID)"
  site_id__n:
    required: false
    type: array
    description: "Site_id not equal to"
  tag:
    required: false
    type: array
    description: "Tag"
  tag__n:
    required: false
    type: array
    description: "Tag not equal to"
  type:
    required: false
    type: array
    description: "Physical port type"
  type__n:
    required: false
    type: array
    description: "Type not equal to"
  updated_by_request:
    required: false
    type: string
    description: "Updated_by_request"
  virtual_chassis:
    required: false
    type: array
    description: "Virtual Chassis"
  virtual_chassis__n:
    required: false
    type: array
    description: "Virtual_chassis not equal to"
  virtual_chassis_id:
    required: false
    type: array
    description: "Virtual Chassis (ID)"
  virtual_chassis_id__n:
    required: false
    type: array
    description: "Virtual_chassis_id not equal to"
  save_in_key_store:
    type: boolean
    default: false
    description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl.
  save_in_key_store_key_name:
    type: string
    description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl.
  save_in_key_store_ttl:
    type: integer
    default: 60
    description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name.
runner_type: python-script