Skip to content

Latest commit

 

History

History
92 lines (75 loc) · 3.92 KB

event_list.md

File metadata and controls

92 lines (75 loc) · 3.92 KB
Raw

event_list

List and filter on Events.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: List all of the events for the current Linode Account
  linode.cloud.event_list: {}
- name: List the latest 5 events for the current Linode Account
  linode.cloud.event_list:
    count: 5
    order_by: created
    order: desc
- name: List all Linode Instance creation events for the current Linode Account
  linode.cloud.event_list:
    filters:
      - name: action
        values: linode_create

Parameters

Field Type Required Description
order str Optional The order to list Events in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Events by.
filters (sub-options) list Optional A list of filters to apply to the resulting Events.
count int Optional The number of Events to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable fields can be found here.
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • events - The returned Events.

    • Sample Response: 
      [
   {
      "action":"ticket_create",
      "created":"2018-01-01T00:01:01",
      "duration":300.56,
      "entity":{
         "id":11111,
         "label":"Problem booting my Linode",
         "type":"ticket",
         "url":"/v4/support/tickets/11111"
      },
      "id":123,
      "message":"None",
      "percent_complete":null,
      "rate":null,
      "read":true,
      "secondary_entity":{
         "id":"linode/debian11",
         "label":"linode1234",
         "type":"linode",
         "url":"/v4/linode/instances/1234"
      },
      "seen":true,
      "status":null,
      "time_remaining":null,
      "username":"exampleUser"
   }
]
    • See the Linode API response documentation for a list of returned fields