Cloud Management API 1.5
NetworkOptionGroups
A key/value pair hash containing options for configuring a Network.
The key/value pairs are stored in the "options" parameter.
Keys correspond to the type of option to set, and values correspond to the value of the particular option being set.
Option keys that are supported vary depending on cloud -- please consult your particular cloud's documentation for available option keys.
Actions
index
List NetworkOptionGroups available in this account.
- URLs
- GET /api/network_option_groups
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.network_option_group;type=collection
Required roles
- observer
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
Filters
| name | partial_match? | description |
|---|---|---|
| cloud_href | no | Returns NetworkOptionGroups in the specified cloud |
| description | yes | Returns NetworkOptionGroups containing the specified description |
| name | yes | Returns NetworkOptionGroups containing the specified name |
| type | no | Returns NetworkOptionGroups with the specified types |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"resource_uid": "RESOURCE_3514523374",
"name": "NAME_611570019",
"description": null,
"links": [
{"rel":"self","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"type": "aws-dhcp-options",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"options": {
"dns_names": "xxx.com"
}
},{
"resource_uid": "RESOURCE_692390643",
"name": "NAME_1315339180",
"description": null,
"links": [
{"rel":"self","href":"/api/network_option_groups/RESOURCE_692390643;1319479637"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"type": "aws-dhcp-options",
"created_at": "2023/10/09 11:06:03 +0000",
"updated_at": "2023/10/09 11:06:03 +0000",
"options": {
"dns_names": "xxx.com"
}
}]<?xml version="1.0" encoding="UTF-8"?>
<network_option_groups>
<network_option_group>
<resource_uid>RESOURCE_3514523374</resource_uid>
<name>NAME_611570019</name>
<description/>
<links>
<link rel="self" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<type>aws-dhcp-options</type>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<options>
<dns_names>xxx.com</dns_names>
</options>
</network_option_group>
<network_option_group>
<resource_uid>RESOURCE_692390643</resource_uid>
<name>NAME_1315339180</name>
<description/>
<links>
<link rel="self" href="/api/network_option_groups/RESOURCE_692390643;1319479637"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<type>aws-dhcp-options</type>
<created_at>2023/10/09 11:06:03 +0000</created_at>
<updated_at>2023/10/09 11:06:03 +0000</updated_at>
<options>
<dns_names>xxx.com</dns_names>
</options>
</network_option_group>
</network_option_groups>
show
Show information about a single NetworkOptionGroup.
- URLs
- GET /api/network_option_groups/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.network_option_group
Required roles
- observer
Example Responses
Click on a format below to see an example response:
JSON XML{
"resource_uid": "RESOURCE_3514523374",
"name": "NAME_611570019",
"description": null,
"links": [
{"rel":"self","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"type": "aws-dhcp-options",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"options": {
"dns_names": "xxx.com"
}
}<?xml version="1.0" encoding="UTF-8"?>
<network_option_group>
<resource_uid>RESOURCE_3514523374</resource_uid>
<name>NAME_611570019</name>
<description/>
<links>
<link rel="self" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<type>aws-dhcp-options</type>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<options>
<dns_names>xxx.com</dns_names>
</options>
</network_option_group>
create
Create a new NetworkOptionGroup.
- URLs
- POST /api/network_option_groups
- HTTP response code
- 201 Created
Required roles
- security_manager
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| network_option_group | yes | Hash | * | * | no | |
| network_option_group[cloud_href] | yes | String | * | * | no | The Cloud to create this NetworkOptionGroup in |
| network_option_group[description] | no | String | * | * | yes | Description of this NetworkOptionGroup |
| network_option_group[name] | no | String | * | * | yes | Name of this NetworkOptionGroup |
| network_option_group[options] | yes | Hash | * | * | no | |
| network_option_group[options][*] | no | String | * | * | no | Key/Value separated options (ex: network_option_group[options][domain-name]='rightscale.com' |
| network_option_group[type] | yes | String | * | * | no | Type of this NetworkOptionGroup |
update
Update an existing NetworkOptionGroup.
- URLs
- PUT /api/network_option_groups/:id
- HTTP response code
- 204 No Content
Required roles
- security_manager
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| network_option_group | yes | Hash | * | * | no | |
| network_option_group[description] | no | String | * | * | yes | Update the description |
| network_option_group[name] | no | String | * | * | yes | Update the name |
| network_option_group[options][*] | no | String | * | * | no | Add new or update existing key/value option pairs. |
destroy
Delete an existing NetworkOptionGroup.
- URLs
- DELETE /api/network_option_groups/:id
- HTTP response code
- 204 No Content
Required roles
- security_manager