sol_network_operations

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

Overview

Name	sol_network_operations
Type	Resource
Id	aws.tnb.sol_network_operations

Fields

The following fields are returned by SELECT queries:

get_sol_network_operation

Name	Datatype	Description
id	string	ID of this network operation occurrence. (pattern: <code>^no-[a-f0-9]{17}$</code>)
arn	string	Network operation ARN. (pattern: <code>^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-operation/no-[a-f0-9]{17})$</code>)
error	object	Error related to this specific network operation occurrence.
lcm_operation_type	string	Type of the operation represented by this occurrence. (INSTANTIATE, UPDATE, TERMINATE)
metadata	object	Metadata of this network operation occurrence.
ns_instance_id	string	ID of the network operation instance. (pattern: <code>^ni-[a-f0-9]{17}$</code>)
operation_state	string	The state of the network operation. (PROCESSING, COMPLETED, FAILED, CANCELLING, CANCELLED)
tags	object	A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
tasks	array	All tasks associated with this operation occurrence.
update_type	string	Type of the update. Only present if the network operation lcmOperationType is UPDATE. (MODIFY_VNF_INFORMATION, UPDATE_NS)

list_sol_network_operations

Name	Datatype	Description
id	string	ID of this network operation. (pattern: <code>^no-[a-f0-9]{17}$</code>)
arn	string	Network operation ARN. (pattern: <code>^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-operation/no-[a-f0-9]{17})$</code>)
error	object	Error related to this specific network operation.
lcm_operation_type	string	Type of lifecycle management network operation. (INSTANTIATE, UPDATE, TERMINATE)
metadata	object	Metadata related to this network operation.
ns_instance_id	string	ID of the network instance related to this operation. (pattern: <code>^ni-[a-f0-9]{17}$</code>)
operation_state	string	The state of the network operation. (PROCESSING, COMPLETED, FAILED, CANCELLING, CANCELLED)
update_type	string	Type of the update. Only present if the network operation lcmOperationType is UPDATE. (MODIFY_VNF_INFORMATION, UPDATE_NS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sol_network_operation	select	ns_lcm_op_occ_id, region		Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks. A network operation is any operation that is done to your network, such as network instance instantiation or termination.
list_sol_network_operations	select	region	max_results, nextpage_opaque_marker, nsInstanceId	Lists details for a network operation, including when the operation started and the status of the operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination.

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
ns_lcm_op_occ_id	string	The identifier of the network operation.
region	string	AWS region (default: us-east-1)
max_results	integer	The maximum number of results to include in the response.
nextpage_opaque_marker	string	The token for the next page of results.
nsInstanceId	string	Network instance id filter, to retrieve network operations associated to a network instance.

SELECT examples

get_sol_network_operation

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks. A network operation is any operation that is done to your network, such as network instance instantiation or termination.

SELECT
id,
arn,
error,
lcm_operation_type,
metadata,
ns_instance_id,
operation_state,
tags,
tasks,
update_type
FROM aws.tnb.sol_network_operations
WHERE ns_lcm_op_occ_id = '{{ ns_lcm_op_occ_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sol_network_operations

Lists details for a network operation, including when the operation started and the status of the operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination.

SELECT
id,
arn,
error,
lcm_operation_type,
metadata,
ns_instance_id,
operation_state,
update_type
FROM aws.tnb.sol_network_operations
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND nextpage_opaque_marker = '{{ nextpage_opaque_marker }}'
AND nsInstanceId = '{{ nsInstanceId }}'
;