get.dcim.modules.yaml

# This action was auto generated from the NetBox API Swagger Spec
# NetBox API version: 4.0
description: "Get a list of module objects."
enabled: true
entry_point: run.py
name: get.dcim.modules
parameters:
  endpoint_uri:
    default: "/dcim/modules/"
    immutable: true
    type: string
  http_verb:
    default: get
    immutable: true
    type: string
  get_detail_route_eligible:
    default: true
    immutable: true
    type: boolean
  asset_tag:
    required: false
    type: array
    description: "Asset_tag"
  asset_tag__empty:
    required: false
    type: boolean
    description: "Asset_tag is empty/null (boolean)"
  asset_tag__ic:
    required: false
    type: array
    description: "Asset_tag contains (case-insensitive)"
  asset_tag__ie:
    required: false
    type: array
    description: "Asset_tag exact match (case-insensitive)"
  asset_tag__iew:
    required: false
    type: array
    description: "Asset_tag ends with (case-insensitive)"
  asset_tag__isw:
    required: false
    type: array
    description: "Asset_tag starts with (case-sensitive)"
  asset_tag__n:
    required: false
    type: array
    description: "Asset_tag not equal to"
  asset_tag__nic:
    required: false
    type: array
    description: "Asset_tag does not contain (case-insensitive)"
  asset_tag__nie:
    required: false
    type: array
    description: "Asset_tag inverse exact match (case-insensitive)"
  asset_tag__niew:
    required: false
    type: array
    description: "Asset_tag does not end with (case-insensitive)"
  asset_tag__nisw:
    required: false
    type: array
    description: "Asset_tag does not start with (case-sensitive)"
  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_id:
    required: false
    type: array
    description: "Device (ID)"
  device_id__n:
    required: false
    type: array
    description: "Device_id 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"
  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."
  manufacturer:
    required: false
    type: array
    description: "Manufacturer (slug)"
  manufacturer__n:
    required: false
    type: array
    description: "Manufacturer not equal to"
  manufacturer_id:
    required: false
    type: array
    description: "Manufacturer (ID)"
  manufacturer_id__n:
    required: false
    type: array
    description: "Manufacturer_id not equal to"
  modified_by_request:
    required: false
    type: string
    description: "Modified_by_request"
  module_bay_id:
    required: false
    type: array
    description: "Module Bay (ID)"
  module_bay_id__n:
    required: false
    type: array
    description: "Module_bay_id not equal to"
  module_type:
    required: false
    type: array
    description: "Module type (model)"
  module_type__n:
    required: false
    type: array
    description: "Module_type not equal to"
  module_type_id:
    required: false
    type: array
    description: "Module type (ID)"
  module_type_id__n:
    required: false
    type: array
    description: "Module_type_id not equal to"
  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."
  q:
    required: false
    type: string
    description: "Search"
  serial:
    required: false
    type: array
    description: "Serial"
  serial__empty:
    required: false
    type: boolean
    description: "Serial is empty/null (boolean)"
  serial__ic:
    required: false
    type: array
    description: "Serial contains (case-insensitive)"
  serial__ie:
    required: false
    type: array
    description: "Serial exact match (case-insensitive)"
  serial__iew:
    required: false
    type: array
    description: "Serial ends with (case-insensitive)"
  serial__isw:
    required: false
    type: array
    description: "Serial starts with (case-sensitive)"
  serial__n:
    required: false
    type: array
    description: "Serial not equal to"
  serial__nic:
    required: false
    type: array
    description: "Serial does not contain (case-insensitive)"
  serial__nie:
    required: false
    type: array
    description: "Serial inverse exact match (case-insensitive)"
  serial__niew:
    required: false
    type: array
    description: "Serial does not end with (case-insensitive)"
  serial__nisw:
    required: false
    type: array
    description: "Serial does not start with (case-sensitive)"
  status:
    required: false
    type: array
    description: "Status"
  status__n:
    required: false
    type: array
    description: "Status not equal to"
  tag:
    required: false
    type: array
    description: "Tag"
  tag__n:
    required: false
    type: array
    description: "Tag not equal to"
  updated_by_request:
    required: false
    type: string
    description: "Updated_by_request"
  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