Cloud Management API 1.5

NetworkOptionGroupAttachments

Resource for attaching NetworkOptionGroups to Networks.

A single NetworkOptionGroup can be attached to many Networks. A Network/Subnet can have many NetworkOptionGroups attached, as long as the NetworkOptionGroups each have different types.

This resource describes the attachment details between a particular NetworkOptionGroup and Network.

Amazon currently only supports attaching NetworkOptionGroups to Networks. Other clouds in the future may support attaching to Subnets.

index

List NetworkOptionGroupAttachments in this account.

URLs: GET /api/network_option_group_attachments
HTTP response code: 200 OK
Content-type: application/vnd.rightscale.network_option_group_attachment;type=collection

Required roles

observer

Parameters

name	required	type	values	regexp	blank?	description
filter	no	Array	*	*	no	See below for valid filter parameters.
view	no	String	default, extended	*	no	Specifies how many attributes and/or expanded nested relationships to include.

Filters

name	partial_match?	description
cloud_href	no	Returns NetworkOptionGroupAttachments in the specified cloud
network_href	no	Returns NetworkOptionGroupAttachments attached to the specified Network
network_option_group_href	no	Returns NetworkOptionGroupAttachments attached with the specified NetworkOptionGroup

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML

[{
  "resource_uid": "RESOURCE_2950379223",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
    {"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"}
  ],
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000"
},{
  "resource_uid": "RESOURCE_3999823704",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_3999823704;680669583"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_692390643;1319479637"},
    {"rel":"network","href":"/api/networks/RESOURCE_699566851;2110264605"}
  ],
  "created_at": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +0000"
}]

<?xml version="1.0" encoding="UTF-8"?>
<network_option_group_attachments>
  <network_option_group_attachment>
    <resource_uid>RESOURCE_2950379223</resource_uid>
    <links>
      <link rel="self" href="/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
      <link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
    </links>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +0000</updated_at>
  </network_option_group_attachment>
  <network_option_group_attachment>
    <resource_uid>RESOURCE_3999823704</resource_uid>
    <links>
      <link rel="self" href="/api/network_option_group_attachments/RESOURCE_3999823704;680669583"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_692390643;1319479637"/>
      <link rel="network" href="/api/networks/RESOURCE_699566851;2110264605"/>
    </links>
    <created_at>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +0000</updated_at>
  </network_option_group_attachment>
</network_option_group_attachments>

Click on a format below to see an example response for the 'extended' view:

JSON XML

[{
  "resource_uid": "RESOURCE_2950379223",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
    {"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"}
  ],
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "network_option_group": {
    "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_3999823704",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_3999823704;680669583"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_692390643;1319479637"},
    {"rel":"network","href":"/api/networks/RESOURCE_699566851;2110264605"}
  ],
  "created_at": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +0000",
  "network_option_group": {
    "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_group_attachments>
  <network_option_group_attachment>
    <resource_uid>RESOURCE_2950379223</resource_uid>
    <links>
      <link rel="self" href="/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
      <link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
    </links>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +0000</updated_at>
    <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_attachment>
  <network_option_group_attachment>
    <resource_uid>RESOURCE_3999823704</resource_uid>
    <links>
      <link rel="self" href="/api/network_option_group_attachments/RESOURCE_3999823704;680669583"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_692390643;1319479637"/>
      <link rel="network" href="/api/networks/RESOURCE_699566851;2110264605"/>
    </links>
    <created_at>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +0000</updated_at>
    <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_group_attachment>
</network_option_group_attachments>

show

Show information about a single NetworkOptionGroupAttachment.

URLs: GET /api/network_option_group_attachments/:id
HTTP response code: 200 OK
Content-type: application/vnd.rightscale.network_option_group_attachment

Required roles

observer

Parameters

name	required	type	values	regexp	blank?	description
view	no	String	default, extended	*	no	Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML

{
  "resource_uid": "RESOURCE_2950379223",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
    {"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"}
  ],
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000"
}

<?xml version="1.0" encoding="UTF-8"?>
<network_option_group_attachment>
  <resource_uid>RESOURCE_2950379223</resource_uid>
  <links>
    <link rel="self" href="/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
    <link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
  </links>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +0000</updated_at>
</network_option_group_attachment>

Click on a format below to see an example response for the 'extended' view:

JSON XML

{
  "resource_uid": "RESOURCE_2950379223",
  "links": [
    {"rel":"self","href":"/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"network_option_group","href":"/api/network_option_groups/RESOURCE_3514523374;3630796668"},
    {"rel":"network","href":"/api/networks/RESOURCE_1164412747;268981889"}
  ],
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "network_option_group": {
    "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_attachment>
  <resource_uid>RESOURCE_2950379223</resource_uid>
  <links>
    <link rel="self" href="/api/network_option_group_attachments/RESOURCE_2950379223;1377342634"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="network_option_group" href="/api/network_option_groups/RESOURCE_3514523374;3630796668"/>
    <link rel="network" href="/api/networks/RESOURCE_1164412747;268981889"/>
  </links>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +0000</updated_at>
  <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_attachment>

create

Create a new NetworkOptionGroupAttachment.

URLs: POST /api/network_option_group_attachments
HTTP response code: 201 Created

Required roles

security_manager

Parameters

name	required	type	values	regexp	blank?	description
network_option_group_attachment	yes	Hash	*	*	no
network_option_group_attachment[network_href]	yes	String	*	*	no	The Network to attach the specified NetworkOptionGroup to.
network_option_group_attachment[network_option_group_href]	no	String	*	*	no	The NetworkOptionGroup to attach to the specified resource.

update

Update an existing NetworkOptionGroupAttachment.

URLs: PUT /api/network_option_group_attachments/:id
HTTP response code: 204 No Content

Required roles

security_manager

Parameters

name	required	type	values	regexp	blank?	description
network_option_group_attachment	yes	Hash	*	*	no
network_option_group_attachment[network_option_group_href]	no	String	*	*	no	The NetworkOptionGroup to attach to the specified resource.

destroy

Delete an existing NetworkOptionGroupAttachment.

URLs: DELETE /api/network_option_group_attachments/:id
HTTP response code: 204 No Content

Required roles

security_manager

MediaTypes:

Resources:

NetworkOptionGroupAttachments

Actions

index

Required roles

Parameters

Filters

Example Responses

Click on a format below to see an example response for the 'default' view:

Click on a format below to see an example response for the 'extended' view:

show

Required roles

Parameters

Example Responses

Click on a format below to see an example response for the 'default' view:

Click on a format below to see an example response for the 'extended' view:

create

Required roles

Parameters

update

Required roles

Parameters

destroy

Required roles