forked from linode/ansible_linode
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' into new/docs-validation
- Loading branch information
Showing
29 changed files
with
893 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # lke_type_list | ||
|
|
||
| List and filter on LKE Types. | ||
|
|
||
| - [Minimum Required Fields](#minimum-required-fields) | ||
| - [Examples](#examples) | ||
| - [Parameters](#parameters) | ||
| - [Return Values](#return-values) | ||
|
|
||
| ## Minimum Required Fields | ||
| | Field | Type | Required | Description | | ||
| |-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). | | ||
|
|
||
| ## Examples | ||
|
|
||
| ```yaml | ||
| - name: List all of the Linode LKE Types | ||
| linode.cloud.lke_type_list: {} | ||
| ``` | ||
| ```yaml | ||
| - name: List a Linode LKE Type named LKE High Availability | ||
| linode.cloud.lke_type_list: | ||
| filters: | ||
| - name: label | ||
| values: LKE High Availability | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
| ## Parameters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `order` | <center>`str`</center> | <center>Optional</center> | The order to list LKE Types in. **(Choices: `desc`, `asc`; Default: `asc`)** | | ||
| | `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order LKE Types by. | | ||
| | [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting LKE Types. | | ||
| | `count` | <center>`int`</center> | <center>Optional</center> | The number of LKE Types to return. If undefined, all results will be returned. | | ||
|
|
||
| ### filters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/api). | | ||
| | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. | | ||
|
|
||
| ## Return Values | ||
|
|
||
| - `lke_types` - The returned LKE Types. | ||
|
|
||
| - Sample Response: | ||
| ```json | ||
| [ | ||
| { | ||
| "id": "lke-ha", | ||
| "label": "LKE High Availability", | ||
| "price": { | ||
| "hourly": 0.09, | ||
| "monthly": 60.0 | ||
| }, | ||
| "region_prices": [ | ||
| { | ||
| "id": "id-cgk", | ||
| "hourly": 0.108, | ||
| "monthly": 72.0 | ||
| }, | ||
| { | ||
| "id": "br-gru", | ||
| "hourly": 0.126, | ||
| "monthly": 84.0 | ||
| } | ||
| ], | ||
| "transfer": 0 | ||
| } | ||
| ] | ||
| ``` | ||
| - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/api) for a list of returned fields | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # network_transfer_prices_list | ||
|
|
||
| List and filter on Network Transfer Prices. | ||
|
|
||
| - [Minimum Required Fields](#minimum-required-fields) | ||
| - [Examples](#examples) | ||
| - [Parameters](#parameters) | ||
| - [Return Values](#return-values) | ||
|
|
||
| ## Minimum Required Fields | ||
| | Field | Type | Required | Description | | ||
| |-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). | | ||
|
|
||
| ## Examples | ||
|
|
||
| ```yaml | ||
| - name: List all of the Linode Network Transfer Prices | ||
| linode.cloud.network_transfer_prices_list: {} | ||
| ``` | ||
| ```yaml | ||
| - name: List a Linode Network Transfer Price named Distributed Network Transfer | ||
| linode.cloud.network_transfer_prices_list: | ||
| filters: | ||
| - name: label | ||
| values: Distributed Network Transfer | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
| ## Parameters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `order` | <center>`str`</center> | <center>Optional</center> | The order to list Network Transfer Prices in. **(Choices: `desc`, `asc`; Default: `asc`)** | | ||
| | `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Network Transfer Prices by. | | ||
| | [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Network Transfer Prices. | | ||
| | `count` | <center>`int`</center> | <center>Optional</center> | The number of Network Transfer Prices to return. If undefined, all results will be returned. | | ||
|
|
||
| ### filters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-network-transfer-prices). | | ||
| | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. | | ||
|
|
||
| ## Return Values | ||
|
|
||
| - `network_transfer_prices` - The returned Network Transfer Prices. | ||
|
|
||
| - Sample Response: | ||
| ```json | ||
| [ | ||
| { | ||
| "id": "distributed_network_transfer", | ||
| "label": "Distributed Network Transfer", | ||
| "price": { | ||
| "hourly": 0.01, | ||
| "monthly": null | ||
| }, | ||
| "region_prices": [], | ||
| "transfer": 0 | ||
| } | ||
| ] | ||
| ``` | ||
| - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-network-transfer-prices) for a list of returned fields | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # nodebalancer_type_list | ||
|
|
||
| List and filter on Node Balancer Types. | ||
|
|
||
| - [Minimum Required Fields](#minimum-required-fields) | ||
| - [Examples](#examples) | ||
| - [Parameters](#parameters) | ||
| - [Return Values](#return-values) | ||
|
|
||
| ## Minimum Required Fields | ||
| | Field | Type | Required | Description | | ||
| |-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). | | ||
|
|
||
| ## Examples | ||
|
|
||
| ```yaml | ||
| - name: List all of the Linode Node Balancer Types | ||
| linode.cloud.nodebalancer_type_list: {} | ||
| ``` | ||
| ```yaml | ||
| - name: List a Linode Node Balancer Type named NodeBalancer | ||
| linode.cloud.nodebalancer_type_list: | ||
| filters: | ||
| - name: label | ||
| values: NodeBalancer | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
| ## Parameters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `order` | <center>`str`</center> | <center>Optional</center> | The order to list Node Balancer Types in. **(Choices: `desc`, `asc`; Default: `asc`)** | | ||
| | `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Node Balancer Types by. | | ||
| | [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Node Balancer Types. | | ||
| | `count` | <center>`int`</center> | <center>Optional</center> | The number of Node Balancer Types to return. If undefined, all results will be returned. | | ||
|
|
||
| ### filters | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/api). | | ||
| | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. | | ||
|
|
||
| ## Return Values | ||
|
|
||
| - `nodebalancer_types` - The returned Node Balancer Types. | ||
|
|
||
| - Sample Response: | ||
| ```json | ||
| [ | ||
| { | ||
| "id": "nodebalancer", | ||
| "label": "NodeBalancer", | ||
| "price": { | ||
| "hourly": 0.015, | ||
| "monthly": 10.0 | ||
| }, | ||
| "region_prices": [ | ||
| { | ||
| "id": "id-cgk", | ||
| "hourly": 0.018, | ||
| "monthly": 12.0 | ||
| }, | ||
| { | ||
| "id": "br-gru", | ||
| "hourly": 0.021, | ||
| "monthly": 14.0 | ||
| } | ||
| ], | ||
| "transfer": 0 | ||
| } | ||
| ] | ||
| ``` | ||
| - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/api) for a list of returned fields | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # region_info | ||
|
|
||
| Get info about a Linode Region. | ||
|
|
||
| - [Minimum Required Fields](#minimum-required-fields) | ||
| - [Examples](#examples) | ||
| - [Parameters](#parameters) | ||
| - [Return Values](#return-values) | ||
|
|
||
| ## Minimum Required Fields | ||
| | Field | Type | Required | Description | | ||
| |-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). | | ||
|
|
||
| ## Examples | ||
|
|
||
| ```yaml | ||
| - name: Get Info of a Linode Region | ||
| linode.cloud.region_info: | ||
| id: us-mia | ||
| ``` | ||
| ## Parameters | ||
| | Field | Type | Required | Description | | ||
| |-----------|------|----------|------------------------------------------------------------------------------| | ||
| | `id` | <center>`str`</center> | <center>**Required**</center> | The ID of the Region to resolve. | | ||
|
|
||
| ## Return Values | ||
|
|
||
| - `region` - The returned Region. | ||
|
|
||
| - Sample Response: | ||
| ```json | ||
| { | ||
| "id": "us-mia", | ||
| "label": "Miami, FL", | ||
| "country": "us", | ||
| "capabilities": [ | ||
| "Linodes", | ||
| "Backups", | ||
| "NodeBalancers", | ||
| "Block Storage", | ||
| "Object Storage", | ||
| "Kubernetes", | ||
| "Cloud Firewall", | ||
| "Vlans", | ||
| "VPCs", | ||
| "Metadata", | ||
| "Premium Plans", | ||
| "Placement Group" | ||
| ], | ||
| "status": "ok", | ||
| "resolvers": { | ||
| "ipv4": "172.233.160.34, 172.233.160.27, 172.233.160.30, 172.233.160.29, 172.233.160.32, 172.233.160.28, 172.233.160.33, 172.233.160.26, 172.233.160.25, 172.233.160.31", | ||
| "ipv6": "2a01:7e04::f03c:93ff:fead:d31f, 2a01:7e04::f03c:93ff:fead:d37f, 2a01:7e04::f03c:93ff:fead:d30c, 2a01:7e04::f03c:93ff:fead:d318, 2a01:7e04::f03c:93ff:fead:d316, 2a01:7e04::f03c:93ff:fead:d339, 2a01:7e04::f03c:93ff:fead:d367, 2a01:7e04::f03c:93ff:fead:d395, 2a01:7e04::f03c:93ff:fead:d3d0, 2a01:7e04::f03c:93ff:fead:d38e" | ||
| }, | ||
| "placement_group_limits": { | ||
| "maximum_pgs_per_customer": null, | ||
| "maximum_linodes_per_pg": 5 | ||
| }, | ||
| "site_type": "core" | ||
| } | ||
| ``` | ||
| - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-region) for a list of returned fields | ||
|
|
||
|
|
Oops, something went wrong.