Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 3.82 KB

child_account_list.md

File metadata and controls

79 lines (63 loc) · 3.82 KB
Raw

child_account_list

List and filter on Child Account.

NOTE: Parent/Child related features may not be generally available.

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 Child Accounts under the current Account
  linode.cloud.child_account_list: {}

Parameters

Field Type Required Description
order str Optional The order to list Child Account in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Child Account by.
filters (sub-options) list Optional A list of filters to apply to the resulting Child Account.
count int Optional The number of Child Account 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

  • child_accounts - The returned Child Account.

    • Sample Response: 
      {
    "active_since": "2018-01-01T00:01:01",
    "address_1": "123 Main Street",
    "address_2": "Suite A",
    "balance": 200,
    "balance_uninvoiced": 145,
    "billing_source": "external",
    "capabilities": [
        "Linodes",
        "NodeBalancers",
        "Block Storage",
        "Object Storage"
    ],
    "city": "Philadelphia",
    "company": "Linode LLC",
    "country": "US",
    "credit_card": {
        "expiry": "11/2022",
        "last_four": 1111
    },
    "email": "[email protected]",
    "euuid": "E1AF5EEC-526F-487D-B317EBEB34C87D71",
    "first_name": "John",
    "last_name": "Smith",
    "phone": "215-555-1212",
    "state": "PA",
    "tax_id": "ATU99999999",
    "zip": "19102-1234"
}
    • See the Linode API response documentation for a list of returned fields