datacenter_nsxt_edges

Creates, updates, deletes, gets or lists a datacenter_nsxt_edges resource.

Overview

Name	datacenter_nsxt_edges
Type	Resource
Id	ovh.dedicated_cloud.datacenter_nsxt_edges

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the NSX-T Edge
host_id	integer	Host id where NSX-T Edge is located (wire: hostId)
nsxt_edge_id	integer	Id of the NSX-T Edge (wire: nsxtEdgeId)
disk_location	string	Location of NSX-T Edge disks (wire: diskLocation)
ip	string (ipv4)	IP of the NSX-T Edge (example: 192.0.2.0)
mo_ref	string	The VMware MoRef of the NSX-T Edge (wire: moRef)
size	string	Size of the NSX-T Edge (LARGE, MEDIUM, XLARGE)
state	string	State of the NSX-T Edge (available, delivered, disabled, disabling, error, migrating, provisionning, recycling, reserved, toDisable, toProvision, toRecycle, toRemove, toUnprovision, unprovisionning, upgrading)

list

NSX-T Edge

Name	Datatype	Description
name	string	Name of the NSX-T Edge
host_id	integer	Host id where NSX-T Edge is located (wire: hostId)
nsxt_edge_id	integer	Id of the NSX-T Edge (wire: nsxtEdgeId)
disk_location	string	Location of NSX-T Edge disks (wire: diskLocation)
ip	string (ipv4)	IP of the NSX-T Edge (example: 192.0.2.0)
mo_ref	string	The VMware MoRef of the NSX-T Edge (wire: moRef)
size	string	Size of the NSX-T Edge (LARGE, MEDIUM, XLARGE)
state	string	State of the NSX-T Edge (available, delivered, disabled, disabling, error, migrating, provisionning, recycling, reserved, toDisable, toProvision, toRecycle, toRemove, toUnprovision, unprovisionning, upgrading)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	datacenter_id, nsxt_edge_id, service_name		Get an edge node
list	select	datacenter_id, service_name	x_pagination_mode	List edge nodes
create	insert	datacenter_id, service_name		Create an edge node
delete	delete	datacenter_id, nsxt_edge_id, service_name		Delete an edge node. Removes the NSX-T edge node from the datacenter. Returns a task to track progress.
relocate_edge	exec	datacenterId, nsxtEdgeId, serviceName		Relocate an edge node. Moves the compute resources of the edge node to another host, its disks to another datastore, or both. Returns a task to track progress.

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"}})
datacenterId	integer	Id of the Datacenter
datacenter_id	integer	Id of the Datacenter (wire: datacenterId)
nsxtEdgeId	integer	Id of the NSX-T Edge
nsxt_edge_id	integer	Id of the NSX-T Edge (wire: nsxtEdgeId)
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get an edge node

SELECT
name,
host_id,
nsxt_edge_id,
disk_location,
ip,
mo_ref,
size,
state
FROM ovh.dedicated_cloud.datacenter_nsxt_edges
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND nsxt_edge_id = '{{ nsxt_edge_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List edge nodes

SELECT
name,
host_id,
nsxt_edge_id,
disk_location,
ip,
mo_ref,
size,
state
FROM ovh.dedicated_cloud.datacenter_nsxt_edges
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an edge node

INSERT INTO ovh.dedicated_cloud.datacenter_nsxt_edges (
datacenter_id,
service_name
)
SELECT 
'{{ datacenter_id }}',
'{{ service_name }}'
RETURNING
name,
datacenter_id,
filer_id,
host_id,
network_access_id,
order_id,
parent_task_id,
task_id,
user_id,
vlan_id,
created_by,
created_from,
description,
end_date,
execution_date,
last_modification_date,
maintenance_date_from,
maintenance_date_to,
network,
progress,
state,
type
;

Manifest

# Description fields are for documentation purposes
- name: datacenter_nsxt_edges
props:
  - name: datacenter_id
    value: {{ datacenter_id }}
    description: Required parameter for the datacenter_nsxt_edges resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the datacenter_nsxt_edges resource.

DELETE examples

delete

Delete an edge node. Removes the NSX-T edge node from the datacenter. Returns a task to track progress.

DELETE FROM ovh.dedicated_cloud.datacenter_nsxt_edges
WHERE datacenter_id = '{{ datacenter_id }}' --required
AND nsxt_edge_id = '{{ nsxt_edge_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

relocate_edge

Relocate an edge node. Moves the compute resources of the edge node to another host, its disks to another datastore, or both. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_nsxt_edges.relocate_edge 
@datacenterId='{{ datacenterId }}' --required, 
@nsxtEdgeId='{{ nsxtEdgeId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"datastore": "{{ datastore }}", 
"hostId": {{ hostId }}
}'
;