vrops_outgoing_flows

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

Overview

Name	vrops_outgoing_flows
Type	Resource
Id	ovh.dedicated_cloud.vrops_outgoing_flows

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
outgoing_flow_id	integer	Id of the VMware Aria Operations outgoing flow (wire: outgoingFlowId)
description	string	Outgoing flow description
ip	string (ipv4)	IP address of the remote service (example: 192.0.2.0)
service_port	integer	Remote service port (25, 465, 587 or 2525) (wire: servicePort)
state	string	Outgoing flow state (creating, deleting, delivered, error, toCreate, toDelete, toUpdate, unknown, updating)

list

VMware Aria Operations outgoing flows

Name	Datatype	Description
outgoing_flow_id	integer	Id of the VMware Aria Operations outgoing flow (wire: outgoingFlowId)
description	string	Outgoing flow description
ip	string (ipv4)	IP address of the remote service (example: 192.0.2.0)
service_port	integer	Remote service port (25, 465, 587 or 2525) (wire: servicePort)
state	string	Outgoing flow state (creating, deleting, delivered, error, toCreate, toDelete, toUpdate, unknown, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	outgoing_flow_id, service_name		Get an Aria Operations outgoing flow. Returns the remote IP address and port, description and state of the outgoing flow.
list	select	service_name	x_pagination_mode	List Aria Operations outgoing flows. Returns the IDs of the outgoing flows allowed from Aria Operations.
create	insert	service_name, ip, service_port		Create an Aria Operations outgoing flow. Allows Aria Operations to reach a remote service on port 25, 465, 587 or 2525. Returns a task to track progress.
delete	delete	outgoing_flow_id, service_name		Delete an Aria Operations outgoing flow. Removes the outgoing flow. Returns a task to track progress.
change_properties	exec	outgoingFlowId, serviceName		Update an Aria Operations outgoing flow. Updates the description of the outgoing flow. 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"}})
outgoingFlowId	integer	Id of the VMware Aria Operations outgoing flow
outgoing_flow_id	integer	Id of the VMware Aria Operations outgoing flow (wire: outgoingFlowId)
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 Aria Operations outgoing flow. Returns the remote IP address and port, description and state of the outgoing flow.

SELECT
outgoing_flow_id,
description,
ip,
service_port,
state
FROM ovh.dedicated_cloud.vrops_outgoing_flows
WHERE outgoing_flow_id = '{{ outgoing_flow_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List Aria Operations outgoing flows. Returns the IDs of the outgoing flows allowed from Aria Operations.

SELECT
outgoing_flow_id,
description,
ip,
service_port,
state
FROM ovh.dedicated_cloud.vrops_outgoing_flows
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an Aria Operations outgoing flow. Allows Aria Operations to reach a remote service on port 25, 465, 587 or 2525. Returns a task to track progress.

INSERT INTO ovh.dedicated_cloud.vrops_outgoing_flows (
description,
ip,
service_port,
service_name
)
SELECT 
'{{ description }}',
'{{ ip }}' /* required */,
{{ service_port }} /* required */,
'{{ 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: vrops_outgoing_flows
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the vrops_outgoing_flows resource.
  - name: description
    value: "{{ description }}"
    description: |
      Outgoing flow description
  - name: ip
    value: "{{ ip }}"
    description: |
      IP address of the remote service, e.g. 123.100.200.0
  - name: service_port
    value: {{ service_port }}
    description: |
      Remote service port (25, 465, 587 or 2525)

DELETE examples

delete

Delete an Aria Operations outgoing flow. Removes the outgoing flow. Returns a task to track progress.

DELETE FROM ovh.dedicated_cloud.vrops_outgoing_flows
WHERE outgoing_flow_id = '{{ outgoing_flow_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_properties

Update an Aria Operations outgoing flow. Updates the description of the outgoing flow. Returns a task to track progress.

EXEC ovh.dedicated_cloud.vrops_outgoing_flows.change_properties 
@outgoingFlowId='{{ outgoingFlowId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"description": "{{ description }}"
}'
;