pipelines

async idem_vra.exec.vra.pipeline.pipelines.act_on_pipeline_using_post(hub, ctx, p_id, **kwargs)

Clone a Pipeline Clone a Pipeline with the given id Performs POST /codestream/api/pipelines/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline to be cloned

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) Description for the cloned entity.

• name (string) – (optional in body) Name field for the cloned entity.

• requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.pipelines.clone_pipeline_by_name_using_post(hub, ctx, p_name, p_project, **kwargs)

Clone a Pipeline by project and name Clone a Pipeline with the given project and name Performs POST /codestream/api/pipelines/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) Description for the cloned entity.

• name (string) – (optional in body) Name field for the cloned entity.

• requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.pipelines.create_pipeline_using_post(hub, ctx, name, **kwargs)

Create a Pipeline Create a Pipeline based on the given project Performs POST /codestream/api/pipelines

Parameters:

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• _inputMeta (object) – (optional in body) Additional information about Input Properties

• concurrency (integer) – (optional in body) Number of Executions of the Pipeline that can run concurrently.

• description (string) – (optional in body) A human-friendly description.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• icon (string) – (optional in body) String description of the icon used for this Pipeline.

• input (object) – (optional in body) Map representing the Input properties for the Pipeline.

• notifications (Any) – (optional in body)

• options (array) – (optional in body) Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.

• output (object) – (optional in body) Map representing the Output properties for the Pipeline.

• project (string) – (optional in body) The project this entity belongs to.

• rollbacks (array) – (optional in body) Represents the various Rollback Configurations for the Pipeline

• stageOrder (array) – (optional in body) Represents the order in which Stages will be executed.

• stages (object) – (optional in body) Map representing the details of the various Stages of the Pipeline.

• starred (Any) – (optional in body)

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that were set on on the resource.

• workspace (Any) – (optional in body)

async idem_vra.exec.vra.pipeline.pipelines.delete_pipeline_by_id_using_delete(hub, ctx, p_id, **kwargs)

Delete a Pipeline by id Delete a Pipeline with the given id Performs DELETE /codestream/api/pipelines/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.delete_pipeline_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)

Delete a Pipeline by project and name Delete a Pipeline with the given project and name Performs DELETE /codestream/api/pipelines/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.execute_pipeline_by_id_using_post(hub, ctx, p_id, **kwargs)

Execute a Pipeline Execute a Pipeline based on the given id Performs POST /codestream/api/pipelines/{id}/executions

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• comments (string) – (optional in body)

• executionId (string) – (optional in body)

• executionLink (string) – (optional in body)

• input (object) – (optional in body)

• projectId (string) – (optional in body)

• projectName (string) – (optional in body)

• source (string) – (optional in body)

• tags (array) – (optional in body)

async idem_vra.exec.vra.pipeline.pipelines.execute_pipeline_by_name_using_post(hub, ctx, p_name, p_project, **kwargs)

Execute a Pipeline Execute a Pipeline based on the given project and name Performs POST /codestream/api/pipelines/{project}/{name}/executions

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• comments (string) – (optional in body)

• executionId (string) – (optional in body)

• executionLink (string) – (optional in body)

• input (object) – (optional in body)

• projectId (string) – (optional in body)

• projectName (string) – (optional in body)

• source (string) – (optional in body)

• tags (array) – (optional in body)

async idem_vra.exec.vra.pipeline.pipelines.export_using_get(hub, ctx, **kwargs)

Export Exports a single pipeline (and endpoints referred in that pipeline) or a list

of pipelines/endpoints in a given project or a custom integration with given list of versions as ‘YAML’ in a given project Performs GET /codestream/api/export

Parameters:

• customIntegration (string) – (optional in query) Name of the Custom Integration to be exported

• customIntegrationVersions (string) – (optional in query) Comma separated list of versions of the given custom integration to be exported

• endpoints (string) – (optional in query) Comma separated list of endpoints to be exported in a given project

• exportAllCustomIntegrationVersions (string) – (optional in query) Flag to state if all versions of given custom integration need to be exported

• exportOnlyReleasedCustomIntegrationVersions (string) – (optional in query) Flag to state if only released versions of given custom integration need to be exported

• pipeline (string) – (optional in query) Name of the Pipeline to be exported. Here, all endpoints referred in the pipeline also get exported

• pipelines (string) – (optional in query) Comma separated list of pipelines to be exported in a given project

• project (string) – (optional in query) Name of the Project to which Endpoint(s)/Pipeline(s) belong to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_all_pipelines_using_get(hub, ctx, **kwargs)

Get all Pipelines Get all Pipelines with specified paging and filter parameters. Performs GET /codestream/api/pipelines

Parameters:

• filter (string) – (optional in query) To list with OData like filter

• orderby (string) – (optional in query) Order by attribute

• skip (string) – (optional in query) To skip ‘n’ Pipelines for listing

• top (string) – (optional in query) To list top ‘n’ Pipelines for listing

• page (string) – (optional in query) To select ‘n’th page for listing

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_execution_by_index_and_pipeline_id_using_get(hub, ctx, p_id, p_index, **kwargs)

Get an Execution Get an Execution based on the given pipeline id and execution index Performs GET /codestream/api/pipelines/{id}/executions/{index}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• p_index (string) – (required in path) The index of the Execution

• queryParams (string) – (optional in query) Value of ‘expand’ type for the execution

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_execution_by_name_and_index_using_get(hub, ctx, p_index, p_name, p_project, **kwargs)

Get an Execution Get an Execution based on the given pipeline id and execution index Performs GET /codestream/api/pipelines/{project}/{name}/executions/{index}

Parameters:

• p_index (string) – (required in path) The index of the Execution

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• queryParams (string) – (optional in query) Value of ‘expand’ type for the execution

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_executions_by_id_using_get(hub, ctx, p_id, **kwargs)

Get all Executions of a Pipeline Get all Executions of a Pipeline with specified paging and filter parameters. Performs GET /codestream/api/pipelines/{id}/executions

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• filter (string) – (optional in query) To list with OData like filter

• orderby (string) – (optional in query) Order by attribute

• skip (string) – (optional in query) To skip ‘n’ Executions for listing

• top (string) – (optional in query) To list top ‘n’ Executions for listing

• page (string) – (optional in query) To select ‘n’th page for listing

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_executions_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)

Get all Executions of a Pipeline Get all Executions of a Pipeline with specified paging and filter parameters. Performs GET /codestream/api/pipelines/{project}/{name}/executions

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• filter (string) – (optional in query) To list with OData like filter

• orderby (string) – (optional in query) Order by attribute

• skip (string) – (optional in query) To skip ‘n’ Executions for listing

• top (string) – (optional in query) To list top ‘n’ Executions for listing

• page (string) – (optional in query) To select ‘n’th page for listing

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_pipeline_by_id_using_get(hub, ctx, p_id, **kwargs)

Get a Pipeline Get a Pipeline with the given id Performs GET /codestream/api/pipelines/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_pipeline_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)

Get a Pipeline by project and name Get a Pipeline with the given project and name Performs GET /codestream/api/pipelines/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.get_pipeline_tiles_using_get(hub, ctx, **kwargs)

Get Pipeline Tiles Get Pipeline Tiles Performs GET /codestream/api/pipeline-tiles

Parameters:

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.import_yaml_using_post(hub, ctx, **kwargs)

Import Imports pipeline(s)/endpoint(s) into Aria Automation Pipelines. Performs POST /codestream/api/import

Parameters:

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.pipelines.patch_pipeline_by_name_using_patch(hub, ctx, p_name, p_project, **kwargs)

Update a Pipeline by project and name Update a Pipeline with the given project and name Performs PATCH /codestream/api/pipelines/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description for the Pipeline.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• name (string) – (optional in body) A human-friendly name used as an identifier for the Pipeline.

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that need to be set on the Pipeline.

async idem_vra.exec.vra.pipeline.pipelines.patch_pipeline_global_by_name_using_patch(hub, ctx, p_name, p_project, **kwargs)

Update a pipeline by pipeline name to be shared across projects Update a pipeline to be shared across projects Performs PATCH /codestream/api/pipelines/{project}/{name}/global

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description for the Pipeline.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• name (string) – (optional in body) A human-friendly name used as an identifier for the Pipeline.

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that need to be set on the Pipeline.

async idem_vra.exec.vra.pipeline.pipelines.patch_pipeline_global_using_patch(hub, ctx, p_id, **kwargs)

Update a pipeline by id to be shared across all projects in an Org. Update a pipeline to be shared across projects Performs PATCH /codestream/api/pipelines/{id}/global

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description for the Pipeline.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• name (string) – (optional in body) A human-friendly name used as an identifier for the Pipeline.

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that need to be set on the Pipeline.

async idem_vra.exec.vra.pipeline.pipelines.patch_pipeline_using_patch(hub, ctx, p_id, **kwargs)

Update a Pipeline by id Update a Pipeline with the given id Performs PATCH /codestream/api/pipelines/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description for the Pipeline.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• name (string) – (optional in body) A human-friendly name used as an identifier for the Pipeline.

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that need to be set on the Pipeline.

async idem_vra.exec.vra.pipeline.pipelines.update_pipeline_by_name_using_put(hub, ctx, p_name, p_project, name, **kwargs)

Update a Pipeline by project and name Update a Pipeline with the given project and name Performs PUT /codestream/api/pipelines/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Pipeline

• p_project (string) – (required in path) The project the Pipeline belongs to

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• _inputMeta (object) – (optional in body) Additional information about Input Properties

• concurrency (integer) – (optional in body) Number of Executions of the Pipeline that can run concurrently.

• description (string) – (optional in body) A human-friendly description.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• icon (string) – (optional in body) String description of the icon used for this Pipeline.

• input (object) – (optional in body) Map representing the Input properties for the Pipeline.

• notifications (Any) – (optional in body)

• options (array) – (optional in body) Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.

• output (object) – (optional in body) Map representing the Output properties for the Pipeline.

• project (string) – (optional in body) The project this entity belongs to.

• rollbacks (array) – (optional in body) Represents the various Rollback Configurations for the Pipeline

• stageOrder (array) – (optional in body) Represents the order in which Stages will be executed.

• stages (object) – (optional in body) Map representing the details of the various Stages of the Pipeline.

• starred (Any) – (optional in body)

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that were set on on the resource.

• workspace (Any) – (optional in body)

async idem_vra.exec.vra.pipeline.pipelines.update_pipeline_using_put(hub, ctx, p_id, name, **kwargs)

Update a Pipeline by id Update a Pipeline with the given id Performs PUT /codestream/api/pipelines/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Pipeline

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• _inputMeta (object) – (optional in body) Additional information about Input Properties

• concurrency (integer) – (optional in body) Number of Executions of the Pipeline that can run concurrently.

• description (string) – (optional in body) A human-friendly description.

• enabled (boolean) – (optional in body) Indicates if the Pipeline is in enabled state.

• global (boolean) – (optional in body) Indicates if the pipeline is shared with all projects in an Org.

• icon (string) – (optional in body) String description of the icon used for this Pipeline.

• input (object) – (optional in body) Map representing the Input properties for the Pipeline.

• notifications (Any) – (optional in body)

• options (array) – (optional in body) Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.

• output (object) – (optional in body) Map representing the Output properties for the Pipeline.

• project (string) – (optional in body) The project this entity belongs to.

• rollbacks (array) – (optional in body) Represents the various Rollback Configurations for the Pipeline

• stageOrder (array) – (optional in body) Represents the order in which Stages will be executed.

• stages (object) – (optional in body) Map representing the details of the various Stages of the Pipeline.

• starred (Any) – (optional in body)

• state (string) – (optional in body) Indicates if the Pipeline is enabled/disabled/released to catalog.

• tags (array) – (optional in body) A set of tag keys and optional values that were set on on the resource.

• workspace (Any) – (optional in body)