Skip to content

Commit 3497680

Browse files
committed
update docs
1 parent 00d30b6 commit 3497680

23 files changed

+204
-159
lines changed

website/docs/d/core_cpe_device_shape.html.markdown

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@ description: |-
1010
# Data Source: oci_core_cpe_device_shape
1111
This data source provides details about a specific Cpe Device Shape resource in Oracle Cloud Infrastructure Core service.
1212

13-
get single cpeDeviceShape object and list of the questions need to asked for that single cpeDeviceShape.
13+
Gets the detailed information about the specified CPE device type. This might include a set of questions
14+
that are specific to the particular CPE device type. The customer must supply answers to those questions
15+
(see [UpdateTunnelCpeDeviceConfig](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).
16+
The service merges the answers with a template of other information for the CPE device type. The following
17+
operations return the merged content:
18+
19+
* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/GetCpeDeviceConfigContent)
20+
* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnection/GetIpsecCpeDeviceConfigContent)
21+
* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)
1422

1523

1624
## Example Usage
@@ -26,20 +34,23 @@ data "oci_core_cpe_device_shape" "test_cpe_device_shape" {
2634

2735
The following arguments are supported:
2836

29-
* `cpe_device_shape_id` - (Required) The OCID of the CPE device shape.
37+
* `cpe_device_shape_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape.
3038

3139

3240
## Attributes Reference
3341

3442
The following attributes are exported:
3543

36-
* `cpe_device_info` - customer premise equipment hardware information
37-
* `platform_software_version` - The CPE's vendor/platform version
38-
* `vendor` - The CPE's hardware information
39-
* `cpe_device_shape_id` - The CPE device type's unique identifier.
40-
* `parameters` - list of questions to ask to cusomter regarding their cpe device in order to generate their cpe device config
41-
* `display_name` -
42-
* `explanation` -
43-
* `key` -
44-
* `template` - the template that will be combined together with customer input to render customer cpe device configuration
44+
* `cpe_device_info` - Basic information about this particular CPE device type.
45+
* `platform_software_version` - The platform or software version of the CPE device.
46+
* `vendor` - The vendor that makes the CPE device.
47+
* `cpe_device_shape_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device.
48+
* `parameters` - For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use [UpdateTunnelCpeDeviceConfig](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).
49+
* `display_name` - A descriptive label for the question (for example, to display in a form in a graphical interface).
50+
* `explanation` - A description or explanation of the question, to help the customer answer accurately.
51+
* `key` - A string that identifies the question.
52+
* `template` - A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see:
53+
* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/GetCpeDeviceConfigContent)
54+
* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnection/GetIpsecCpeDeviceConfigContent)
55+
* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)
4556

website/docs/d/core_cpe_device_shapes.html.markdown

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,19 @@ description: |-
1010
# Data Source: oci_core_cpe_device_shapes
1111
This data source provides the list of Cpe Device Shapes in Oracle Cloud Infrastructure Core service.
1212

13-
Lists the customer-premises equipment objects (CPEs)'s hardware information in the specified compartment.
13+
Lists the CPE device types that the Networking service provides CPE configuration
14+
content for (example: Cisco ASA). The content helps a network engineer configure
15+
the actual CPE device represented by a [Cpe](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/) object.
16+
17+
If you want to generate CPE configuration content for one of the returned CPE device types,
18+
ensure that the [Cpe](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/) object's `cpeDeviceShapeId` attribute is set
19+
to the CPE device type's OCID (returned by this operation).
20+
21+
For information about generating CPE configuration content, see these operations:
22+
23+
* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/GetCpeDeviceConfigContent)
24+
* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnection/GetIpsecCpeDeviceConfigContent)
25+
* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)
1426

1527

1628
## Example Usage
@@ -36,13 +48,16 @@ The following attributes are exported:
3648

3749
The following attributes are exported:
3850

39-
* `cpe_device_info` - customer premise equipment hardware information
40-
* `platform_software_version` - The CPE's vendor/platform version
41-
* `vendor` - The CPE's hardware information
42-
* `cpe_device_shape_id` - The CPE device type's unique identifier.
43-
* `parameters` - list of questions to ask to cusomter regarding their cpe device in order to generate their cpe device config
44-
* `display_name` -
45-
* `explanation` -
46-
* `key` -
47-
* `template` - the template that will be combined together with customer input to render customer cpe device configuration
51+
* `cpe_device_info` - Basic information about this particular CPE device type.
52+
* `platform_software_version` - The platform or software version of the CPE device.
53+
* `vendor` - The vendor that makes the CPE device.
54+
* `cpe_device_shape_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device.
55+
* `parameters` - For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use [UpdateTunnelCpeDeviceConfig](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).
56+
* `display_name` - A descriptive label for the question (for example, to display in a form in a graphical interface).
57+
* `explanation` - A description or explanation of the question, to help the customer answer accurately.
58+
* `key` - A string that identifies the question.
59+
* `template` - A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see:
60+
* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/GetCpeDeviceConfigContent)
61+
* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnection/GetIpsecCpeDeviceConfigContent)
62+
* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)
4863

website/docs/d/core_cpes.html.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@ The following attributes are exported:
4040
The following attributes are exported:
4141

4242
* `compartment_id` - The OCID of the compartment containing the CPE.
43-
* `cpe_device_shape_id` - The CPE device type's unique identifier.
43+
* `cpe_device_shape_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE's device type. The Networking service maintains a general list of CPE device types (for example, Cisco ASA). For each type, Oracle provides CPE configuration content that can help a network engineer configure the CPE. The OCID uniquely identifies the type of device. To get the OCIDs for the device types on the list, see [ListCpeDeviceShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CpeDeviceShapeSummary/ListCpeDeviceShapes).
44+
45+
For information about how to generate CPE configuration content for a CPE device type, see:
46+
* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Cpe/GetCpeDeviceConfigContent)
47+
* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnection/GetIpsecCpeDeviceConfigContent)
48+
* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)
49+
* [GetTunnelCpeDeviceConfig](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig)
4450
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
4551
* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
4652
* `freeform_tags` - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`

website/docs/d/core_instance_credentials.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ description: |-
1010
# Data Source: oci_core_instance_credentials
1111
This data source provides details about a specific Instance Credential resource in Oracle Cloud Infrastructure Core service.
1212

13-
Gets the generated credentials for the instance. Only works for instances that require password to log in (E.g. Windows).
14-
For certain OS'es, users will be forced to change the initial credentials.
13+
Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.
14+
For certain operating systems, users will be forced to change the initial credentials.
1515

1616

1717
## Example Usage

website/docs/d/core_network_security_group_security_rules.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The following attributes are exported:
4747
* `destination` - Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
4848

4949
Allowed values:
50-
* An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in the Government Cloud.
50+
* An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
5151
* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Service/), if you're setting up a security rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
5252
* The OCID of a [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/) in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.
5353
* `destination_type` - Type of destination for the rule. Required if `direction` = `EGRESS`.
@@ -70,7 +70,7 @@ The following attributes are exported:
7070
* `source` - Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
7171

7272
Allowed values:
73-
* An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in the Government Cloud.
73+
* An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
7474
* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Service/), if you're setting up a security rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
7575
* The OCID of a [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/) in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.
7676
* `source_type` - Type of source for the rule. Required if `direction` = `INGRESS`.

website/docs/d/core_route_tables.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following attributes are exported:
6666
* `destination` - Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`.
6767

6868
Allowed values:
69-
* IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway. Note that IPv6 addressing is currently supported only in the Government Cloud.
69+
* IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway. Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
7070
* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Service/), if you're setting up a route rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
7171
* `destination_type` - Type of destination for the rule. Required if you provide a `destination`.
7272
* `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.

website/docs/d/core_security_lists.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The following attributes are exported:
5555
* `destination` - Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
5656

5757
Allowed values:
58-
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in the Government Cloud.
58+
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
5959
* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Service/), if you're setting up a security list rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
6060
* `destination_type` - Type of destination for the rule. The default is `CIDR_BLOCK`.
6161

@@ -100,7 +100,7 @@ The following attributes are exported:
100100
* `source` - Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
101101

102102
Allowed values:
103-
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. Note that IPv6 addressing is currently supported only in the Government Cloud.
103+
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
104104
* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Service/), if you're setting up a security list rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
105105
* `source_type` - Type of source for the rule. The default is `CIDR_BLOCK`.
106106
* `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.

website/docs/d/core_subnet.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The following attributes are exported:
4747
Example: `subnet123`
4848
* `freeform_tags` - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
4949
* `id` - The subnet's Oracle ID (OCID).
50-
* `ipv6cidr_block` - For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's private IP address space. The subnet size is always /64. Note that IPv6 addressing is currently supported only in the Government Cloud. Example: `2001:0db8:0123:1111::/64`
50+
* `ipv6cidr_block` - For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's private IP address space. The subnet size is always /64. Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123:1111::/64`
5151
* `ipv6public_cidr_block` - For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's public IP address space. The subnet size is always /64. The left 48 bits are inherited from the `ipv6PublicCidrBlock` of the [Vcn](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Vcn/), and the remaining 16 bits are from the subnet's `ipv6CidrBlock`. Example: `2001:0db8:0123:1111::/64`
5252
* `ipv6virtual_router_ip` - For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678`
5353
* `prohibit_public_ip_on_vnic` - Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CreateVnicDetails/)). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true`

0 commit comments

Comments
 (0)