netapp_networks
Creates, updates, deletes, gets or lists a netapp_networks resource.
Overview​
| Name | netapp_networks |
| Type | Resource |
| Id | ovh.storage.netapp_networks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Network ID |
status | string | Network status (associated, associating, dissociating, to_configure) |
v_rack_services_urn | string | vRack Services URN the network is attached to (wire: vRackServicesURN) |
A network
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Network ID |
status | string | Network status (associated, associating, dissociating, to_configure) |
v_rack_services_urn | string | vRack Services URN the network is attached to (wire: vRackServicesURN) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | network_id, service_name | Returns the network status and the URN of the vRack Services it is attached to. The status moves to associated only after an endpoint is created on the vRack Services, and share access paths are returned only in that status. | |
list | select | service_name | detail | Returns the networks of the service, with only their IDs unless detail is true. A service on the public network has no network, so the list is empty. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
network_id | string (uuid) | Network ID (wire: networkId) |
service_name | string (uuid) | Service name (wire: serviceName) |
detail | boolean | Get detailed information about each network |
SELECT examples​
- get
- list
Returns the network status and the URN of the vRack Services it is attached to. The status moves to associated only after an endpoint is created on the vRack Services, and share access paths are returned only in that status.
SELECT
id,
status,
v_rack_services_urn
FROM ovh.storage.netapp_networks
WHERE network_id = '{{ network_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the networks of the service, with only their IDs unless detail is true. A service on the public network has no network, so the list is empty.
SELECT
id,
status,
v_rack_services_urn
FROM ovh.storage.netapp_networks
WHERE service_name = '{{ service_name }}' -- required
AND detail = '{{ detail }}'
;