Skip to content

Commit

Permalink
docs: Update Fabric data_source attribute selection documentation (#650)
Browse files Browse the repository at this point in the history
* For each Fabric data_source add attribute selection to documentation
with output block examples
  • Loading branch information
thogarty authored Apr 17, 2024
1 parent 0920252 commit 7e46535
Show file tree
Hide file tree
Showing 8 changed files with 376 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/data-sources/equinix_fabric_cloud_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,46 @@ API documentation can be found here - https://developer.equinix.com/dev-docs/fab
data "equinix_fabric_cloud_router" "cloud_router_data_name" {
uuid = "<uuid_of_cloud_router>"
}
output "id" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.id
}
output "name" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.name
}
output "account_number" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.account.0.account_number
}
output "equinix_asn" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.equinix_asn
}
output "metro_code" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.location.0.metro_code
}
output "metro_name" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.location.0.metro_name
}
output "region" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.location.0.region
}
output "package_code" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.package.0.code
}
output "project_id" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.project.0.project_id
}
output "type" {
value = data.equinix_fabric_cloud_router.cloud_router_data_name.type
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
67 changes: 67 additions & 0 deletions docs/data-sources/equinix_fabric_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,73 @@ Fabric V4 API compatible data resource that allow user to fetch connection for a
data "equinix_fabric_connection" "connection_data_name" {
uuid = "<uuid_of_connection>"
}
output "id" {
value = data.equinix_fabric_connection.connection_data_name.id
}
output "name" {
value = data.equinix_fabric_connection.connection_data_name.bandwidth
}
output "account_number" {
value = data.equinix_fabric_connection.connection_data_name.account.0.account_number
}
output "bandwidth" {
value = data.equinix_fabric_connection.connection_data_name.bandwidth
}
output "project_id" {
value = data.equinix_fabric_connection.connection_data_name.project.0.project_id
}
output "redundancy_group" {
value = data.equinix_fabric_connection.connection_data_name.redundancy.0.group
}
output "redundancy_priority" {
value = data.equinix_fabric_connection.connection_data_name.redundancy.0.priority
}
output "state" {
value = data.equinix_fabric_connection.connection_data_name.state
}
output "type" {
value = data.equinix_fabric_connection.connection_data_name.type
}
# Same for z_side just use z_side instead of a_side
output "access_point_type" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.type
}
# Same for z_side just use z_side instead of a_side
output "access_point_link_protocol_type" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.link_protocol.0.type
}
# Same for z_side just use z_side instead of a_side
output "access_point_link_protocol_vlan_tag" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.link_protocol.0.vlan_tag
}
# Same for z_side just use z_side instead of a_side
output "access_point_link_protocol_vlan_c_tag" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.link_protocol.0.vlan_c_tag
}
# Same for z_side just use z_side instead of a_side
output "access_point_link_protocol_vlan_s_tag" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.link_protocol.0.vlan_s_tag
}
# Same for z_side just use z_side instead of a_side
output "access_point_provider_connection_id" {
value = data.equinix_fabric_connection.connection_data_name.a_side.0.access_point.0.provider_connection_id
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
20 changes: 20 additions & 0 deletions docs/data-sources/equinix_fabric_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@ Fabric V4 API compatible data resource that allow user to fetch Fabric Network f
data "equinix_fabric_network" "network_data_name" {
uuid = "<uuid_of_network>"
}
output "id" {
value = data.equinix_fabric_network.network_data_name.id
}
output "name" {
value = data.equinix_fabric_network.network_data_name.name
}
output "scope" {
value = data.equinix_fabric_network.network_data_name.scope
}
output "type" {
value = data.equinix_fabric_network.network_data_name.type
}
output "region" {
value = data.equinix_fabric_network.network_data_name.location.0.region
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
56 changes: 56 additions & 0 deletions docs/data-sources/equinix_fabric_port.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,62 @@ Fabric V4 API compatible data resource that allow user to fetch port by uuid
data "equinix_fabric_port" "port_data_name" {
uuid = "<uuid_of_port>"
}
output "id" {
value = data.equinix_fabric_port.port_data_name.id
}
output "name" {
value = data.equinix_fabric_port.port_data_name.name
}
output "state" {
value = data.equinix_fabric_port.port_data_name.state
}
output "account_name" {
value = data.equinix_fabric_port.port_data_name.account.0.account_name
}
output "type" {
value = data.equinix_fabric_port.port_data_name.type
}
output "bandwidth" {
value = data.equinix_fabric_port.port_data_name.bandwidth
}
output "used_bandwidth" {
value = data.equinix_fabric_port.port_data_name.used_bandwidth
}
output "encapsulation_type" {
value = data.equinix_fabric_port.port_data_name.encapsulation.0.type
}
output "ibx" {
value = data.equinix_fabric_port.port_data_name.location.0.ibx
}
output "metro_code" {
value = data.equinix_fabric_port.port_data_name.location.0.metro_code
}
output "metro_name" {
value = data.equinix_fabric_port.port_data_name.location.0.metro_name
}
output "region" {
value = data.equinix_fabric_port.port_data_name.location.0.region
}
output "device_redundancy_enabled" {
value = data.equinix_fabric_port.port_data_name.device.0.redundancy.0.enabled
}
output "device_redundancy_priority" {
value = data.equinix_fabric_port.port_data_name.device.0.redundancy.0.priority
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
57 changes: 57 additions & 0 deletions docs/data-sources/equinix_fabric_ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,63 @@ data "equinix_fabric_ports" "ports_data_name" {
name = "<name_of_port||port_prefix>"
}
}
output "id" {
value = data.equinix_fabric_port.ports_data_name.data.0.id
}
output "name" {
value = data.equinix_fabric_port.ports_data_name.data.0.name
}
output "state" {
value = data.equinix_fabric_port.ports_data_name.data.0.state
}
output "account_name" {
value = data.equinix_fabric_port.ports_data_name.data.0.account.0.account_name
}
output "type" {
value = data.equinix_fabric_port.ports_data_name.data.0.type
}
output "bandwidth" {
value = data.equinix_fabric_port.ports_data_name.data.0.bandwidth
}
output "used_bandwidth" {
value = data.equinix_fabric_port.ports_data_name.data.0.used_bandwidth
}
output "encapsulation_type" {
value = data.equinix_fabric_port.ports_data_name.data.0.encapsulation.0.type
}
output "ibx" {
value = data.equinix_fabric_port.ports_data_name.data.0.location.0.ibx
}
output "metro_code" {
value = data.equinix_fabric_port.ports_data_name.data.0.location.0.metro_code
}
output "metro_name" {
value = data.equinix_fabric_port.ports_data_name.data.0.location.0.metro_name
}
output "region" {
value = data.equinix_fabric_port.ports_data_name.data.0.location.0.region
}
output "device_redundancy_enabled" {
value = data.equinix_fabric_port.ports_data_name.data.0.device.0.redundancy.0.enabled
}
output "device_redundancy_priority" {
value = data.equinix_fabric_port.ports_data_name.data.0.device.0.redundancy.0.priority
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
48 changes: 48 additions & 0 deletions docs/data-sources/equinix_fabric_routing_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,54 @@ data "equinix_fabric_routing_protocol" "routing_protocol_data_name" {
connection_uuid = "<uuid_of_connection_routing_protocol_is_applied_to>"
uuid = "<uuid_of_routing_protocol>"
}
output "id" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.id
}
output "name" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.name
}
output "type" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.type
}
output "direct_ipv4" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.direct_ipv4.0.equinix_iface_ip
}
output "direct_ipv6" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.direct_ipv6.0.equinix_iface_ip
}
output "bgp_ipv4_customer_peer_ip" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv4.0.customer_peer_ip
}
output "bgp_ipv4_equinix_peer_ip" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv4.0.equinix_peer_ip
}
output "bgp_ipv4_enabled" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv4.0.enabled
}
output "bgp_ipv6_customer_peer_ip" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv6.0.customer_peer_ip
}
output "bgp_ipv6_equinix_peer_ip" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv6.0.equinix_peer_ip
}
output "bgp_ipv6_enabled" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.bgp_ipv6.0.enabled
}
output "customer_asn" {
value = data.equinix_fabric_routing_protocol.routing_protocol_data_name.customer_asn
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
44 changes: 44 additions & 0 deletions docs/data-sources/equinix_fabric_service_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,50 @@ Fabric V4 API compatible data resource that allow user to fetch Service Profile
data "equinix_fabric_service_profile" "service_profile_data_name" {
uuid = "<uuid_of_service_profile>"
}
output "id" {
value = data.equinix_fabric_service_profile.service_profile_data_name.id
}
output "name" {
value = data.equinix_fabric_service_profile.service_profile_data_name.name
}
output "type" {
value = data.equinix_fabric_service_profile.service_profile_data_name.type
}
output "visibility" {
value = data.equinix_fabric_service_profile.service_profile_data_name.visibility
}
output "org_name" {
value = data.equinix_fabric_service_profile.service_profile_data_name.account.0.organization_name
}
output "access_point_type_configs_type" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.type
}
output "allow_remote_connections" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.allow_remote_connections
}
output "supported_bandwidth_0" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.supported_bandwidths.0
}
output "supported_bandwidth_1" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.supported_bandwidths.1
}
output "redundandy_required" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.connection_redundancy_required
}
output "allow_over_subscription" {
value = data.equinix_fabric_service_profile.service_profile_data_name.access_point_type_configs.0.api_config.0.allow_over_subscription
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
Loading

0 comments on commit 7e46535

Please sign in to comment.