Skip to content

Commit

Permalink
feat!: regenerate docs from migrated templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ctreatma committed Apr 12, 2024
1 parent 32786f4 commit 6c59fd9
Show file tree
Hide file tree
Showing 74 changed files with 681 additions and 1,052 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ subcategory: "Fabric"

!> **DEPRECATED** End of Life will be June 30th, 2024. Use `equinix_fabric_service_profile` instead.

Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name
and / or organization.
Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name and / or organization.

## Example usage

```hcl
```terraform
data "equinix_ecx_l2_sellerprofile" "aws" {
name = "AWS Direct Connect"
}
Expand All @@ -36,18 +35,13 @@ In addition to all arguments above, the following attributes are exported:
* `uuid` - Unique identifier of the seller profile.
* `description` - Seller Profile text description.
* `speed_from_api` - Boolean that indicates if seller is deriving connection speed from an API call.
* `speed_customization_allowed` - Boolean that indicates if seller allows customer to enter a
custom connection speed.
* `speed_customization_allowed` - Boolean that indicates if seller allows customer to enter a custom connection speed.
* `redundancy_required` - Boolean that indicate if seller requires connections to be redundant
* `encapsulation` - Seller profile's encapsulation (either Dot1q or QinQ).
* `speed_band` - One or more specifications of speed/bandwidth supported by given seller profile.
See [Speed Band Attribute](#speed-band-attribute) below for more details.
* `metro` - One or more specifications of metro locations supported by seller profile.
See [Metro Attribute](#metro-attribute) below for more details.
* `speed_band` - One or more specifications of speed/bandwidth supported by given seller profile. See [Speed Band Attribute](#speed-band-attribute) below for more details.
* `metro` - One or more specifications of metro locations supported by seller profile. See [Metro Attribute](#metro-attribute) below for more details.

* `additional_info` - One or more specifications of additional buyer information attributes that
can be provided in connection definition that uses given seller profile.
See [Additional Info Attribute](#additional-info-attribute) below for more details.
* `additional_info` - One or more specifications of additional buyer information attributes that can be provided in connection definition that uses given seller profile. See [Additional Info Attribute](#additional-info-attribute) below for more details.

### Speed Band Attribute

Expand All @@ -71,7 +65,5 @@ Each element in the `additional_info` set exports:

* `name` - Name of additional information attribute.
* `description` - Textual description of additional information attribute.
* `data_type` - Data type of additional information attribute. One of `BOOLEAN`, `INTEGER` or
`STRING`.
* `mandatory` - Specifies if additional information is mandatory to create
connection.
* `data_type` - Data type of additional information attribute. One of `BOOLEAN`, `INTEGER` or `STRING`.
* `mandatory` - Specifies if additional information is mandatory to create connection.
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ subcategory: "Fabric"

!> **DEPRECATED** End of Life will be June 30th, 2024. Use `equinix_fabric_service_profiles` instead.

Use this data source to get details of available Equinix Fabric layer 2 seller profiles. It is
possible to apply filtering criteria for returned list of profiles.
Use this data source to get details of available Equinix Fabric layer 2 seller profiles. It is possible to apply filtering criteria for returned list of profiles.

## Example usage

```hcl
```terraform
data "equinix_ecx_l2_sellerprofiles" "aws" {
organization_global_name = "AWS"
metro_codes = ["SV", "DC"]
Expand All @@ -23,10 +22,8 @@ data "equinix_ecx_l2_sellerprofiles" "aws" {

The following arguments are supported:

* `name_regex` - (Optional) A regex string to apply on returned seller profile names and filter
search results.
* `metro_codes` - (Optional) List of metro codes of locations that should be served by resulting
profiles.
* `name_regex` - (Optional) A regex string to apply on returned seller profile names and filter search results.
* `metro_codes` - (Optional) List of metro codes of locations that should be served by resulting profiles.
* `speed_bands` - (Optional) List of speed bands that should be supported by resulting profiles. (** Please see the note below for important information regarding the use of this argument**)
* `organization_name` - (Optional) Name of seller's organization.
* `organization_global_name` - (Optional) Name of seller's global organization.
Expand All @@ -37,5 +34,4 @@ profiles.

In addition to all arguments above, the following attributes are exported:

* `profiles` - List of resulting profiles. Each element in the `profiles` list exports all
[Service Profile Attributes](./equinix_ecx_l2_sellerprofile.md#attributes-reference).
* `profiles` - List of resulting profiles. Each element in the `profiles` list exports all [Service Profile Attributes](./equinix_ecx_l2_sellerprofile.md#attributes-reference).
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use this data source to get details of Equinix Fabric port with a given name.

## Example Usage

```hcl
```terraform
data "equinix_ecx_port" "tf-pri-dot1q" {
name = "sit-001-CX-NY5-NL-Dot1q-BO-10G-PRI-JP-157"
}
Expand All @@ -35,12 +35,8 @@ In addition to all arguments above, the following attributes are exported:
* `region` - Port location region.
* `ibx` - Port location Equinix Business Exchange (IBX).
* `metro_code` - Port location metro code.
* `priority` - The priority of the device (primary / secondary) where the port
resides.
* `priority` - The priority of the device (primary / secondary) where the port resides.
* `encapsulation` - The VLAN encapsulation of the port (Dot1q or QinQ).
* `buyout` - Boolean value that indicates whether the port supports unlimited connections. If
`false`, the port is a standard port with limited connections. If `true`, the port is an
`unlimited connections` port that allows multiple connections at no additional charge.
* `buyout` - Boolean value that indicates whether the port supports unlimited connections. If `false`, the port is a standard port with limited connections. If `true`, the port is an `unlimited connections` port that allows multiple connections at no additional charge.
* `bandwidth` - Port Bandwidth in bytes.
* `status` - Port status that indicates whether a port has been assigned or is ready for
connection.
* `status` - Port status that indicates whether a port has been assigned or is ready for connection.
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ API documentation can be found here - https://developer.equinix.com/dev-docs/fab

## Example Usage

```hcl
```terraform
data "equinix_fabric_cloud_router" "cloud_router_data_name" {
uuid = "<uuid_of_cloud_router>"
}
```

<!-- schema generated by tfplugindocs -->

## Schema

### Required
Expand Down Expand Up @@ -50,14 +51,15 @@ data "equinix_fabric_cloud_router" "cloud_router_data_name" {
- `type` (String) Defines the FCR type like; XF_ROUTER

<a id="nestedatt--account"></a>

### Nested Schema for `account`

Read-Only:

- `account_number` (Number)


<a id="nestedatt--change_log"></a>

### Nested Schema for `change_log`

Read-Only:
Expand All @@ -75,8 +77,8 @@ Read-Only:
- `updated_by_full_name` (String)
- `updated_date_time` (String)


<a id="nestedatt--location"></a>

### Nested Schema for `location`

Read-Only:
Expand All @@ -86,8 +88,8 @@ Read-Only:
- `metro_name` (String)
- `region` (String)


<a id="nestedatt--notifications"></a>

### Nested Schema for `notifications`

Read-Only:
Expand All @@ -96,8 +98,8 @@ Read-Only:
- `send_interval` (String)
- `type` (String)


<a id="nestedatt--order"></a>

### Nested Schema for `order`

Read-Only:
Expand All @@ -107,20 +109,19 @@ Read-Only:
- `order_number` (String)
- `purchase_order_number` (String)


<a id="nestedatt--package"></a>

### Nested Schema for `package`

Read-Only:

- `code` (String)


<a id="nestedatt--project"></a>

### Nested Schema for `project`

Read-Only:

- `href` (String)
- `project_id` (String)

Loading

0 comments on commit 6c59fd9

Please sign in to comment.