actionruns

async idem_vra.exec.vra.abx.actionruns.cancel_action_run_using_patch(hub, ctx, p_id, **kwargs)

Cancel an action run Cancels an action run which is currently being executed Performs PATCH /abx/api/resources/action-runs/{id}/cancel

Parameters:

• p_id (string) – (required in path) ID of the action run

• actionId (string) – (optional in body) ID of the action

• actionType (string) – (optional in body) Type of the action

• actionVersionId (string) – (optional in body) ID of the action version used for the execution

• actionVersionName (string) – (optional in body) Name of the action version used for the execution

• configuration (object) – (optional in body) Configuration of the action run for specific providers

• createdMillis (integer) – (optional in body) Creation time in millis

• endTimeMillis (integer) – (optional in body) Completion time in millis

• errorMessage (string) – (optional in body) Error message in case the run completed with an error

• id (string) – (optional in body) ID of the resource

• inputs (object) – (optional in body) Input parameters of the action

• logs (string) – (optional in body) Action run logs

• name (string) – (optional in body) Name of the resource

• orgId (string) – (optional in body) Org ID of the resource

• outputs (object) – (optional in body) Output parameters generated by the action

• projectId (string) – (optional in body) Project Id of the action (required for non-system actions)

• provider (string) – (optional in body) Provider used for code execution

• runProjectId (string) – (optional in body) Project Id where the project will be executed (required for non-system actions)

• runState (string) – (optional in body) State of the action run

• runtime (string) – (optional in body) Runtime of the action run (python, nodejs, etc…)

• scalable (boolean) – (optional in body)

• source (string) – (optional in body) Source used for the execution

• startTimeMillis (integer) – (optional in body) Start time in millis

• system (boolean) – (optional in body)

• timeoutSeconds (integer) – (optional in body) Timeout in seconds for execution

• triggeredBy (string) – (optional in body) The user who triggered the action run

async idem_vra.exec.vra.abx.actionruns.delete_using_delete2(hub, ctx, **kwargs)

Delete multiple action runs Deletes multiple action runs with their specific ID Performs DELETE /abx/api/resources/action-runs

async idem_vra.exec.vra.abx.actionruns.delete_using_delete3(hub, ctx, p_id, **kwargs)

Delete an action run Deletes an action run with a specific ID Performs DELETE /abx/api/resources/action-runs/{id}

Parameters:

p_id (string) – (required in path) ID of the action run

async idem_vra.exec.vra.abx.actionruns.get_action_runs_by_action_id_using_get(hub, ctx, p_id, **kwargs)

Fetch all action runs of an action Retrieves all action runs of an action Performs GET /abx/api/resources/actions/{id}/action-runs

Parameters:

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

• page (string) – (optional in query) Page to fetch (starting from 0)

• size (string) – (optional in query) Amount of entities per page

async idem_vra.exec.vra.abx.actionruns.get_all_using_get1(hub, ctx, **kwargs)

Fetch all action runs Retrieves all action run entities Performs GET /abx/api/resources/action-runs

Parameters:

• page (string) – (optional in query) Page to fetch (starting from 0)

• size (string) – (optional in query) Amount of entities per page

• id (string) – (optional in query)

• localAddress.address.MCGlobal (boolean) – (optional in query)

• localAddress.address.MCLinkLocal (boolean) – (optional in query)

• localAddress.address.MCNodeLocal (boolean) – (optional in query)

• localAddress.address.MCOrgLocal (boolean) – (optional in query)

• localAddress.address.MCSiteLocal (boolean) – (optional in query)

• localAddress.address.address (string) – (optional in query)

• localAddress.address.anyLocalAddress (boolean) – (optional in query)

• localAddress.address.canonicalHostName (string) – (optional in query)

• localAddress.address.hostAddress (string) – (optional in query)

• localAddress.address.hostName (string) – (optional in query)

• localAddress.address.linkLocalAddress (boolean) – (optional in query)

• localAddress.address.loopbackAddress (boolean) – (optional in query)

• localAddress.address.multicastAddress (boolean) – (optional in query)

• localAddress.address.siteLocalAddress (boolean) – (optional in query)

• localAddress.hostName (string) – (optional in query)

• localAddress.hostString (string) – (optional in query)

• localAddress.port (integer) – (optional in query)

• localAddress.unresolved (boolean) – (optional in query)

• remoteAddress.address.MCGlobal (boolean) – (optional in query)

• remoteAddress.address.MCLinkLocal (boolean) – (optional in query)

• remoteAddress.address.MCNodeLocal (boolean) – (optional in query)

• remoteAddress.address.MCOrgLocal (boolean) – (optional in query)

• remoteAddress.address.MCSiteLocal (boolean) – (optional in query)

• remoteAddress.address.address (string) – (optional in query)

• remoteAddress.address.anyLocalAddress (boolean) – (optional in query)

• remoteAddress.address.canonicalHostName (string) – (optional in query)

• remoteAddress.address.hostAddress (string) – (optional in query)

• remoteAddress.address.hostName (string) – (optional in query)

• remoteAddress.address.linkLocalAddress (boolean) – (optional in query)

• remoteAddress.address.loopbackAddress (boolean) – (optional in query)

• remoteAddress.address.multicastAddress (boolean) – (optional in query)

• remoteAddress.address.siteLocalAddress (boolean) – (optional in query)

• remoteAddress.hostName (string) – (optional in query)

• remoteAddress.hostString (string) – (optional in query)

• remoteAddress.port (integer) – (optional in query)

• remoteAddress.unresolved (boolean) – (optional in query)

• sslInfo.peerCertificates[0].TBSCertificate (string) – (optional in query)

• sslInfo.peerCertificates[0].basicConstraints (integer) – (optional in query)

• sslInfo.peerCertificates[0].encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].extendedKeyUsage (array) – (optional in query)

• sslInfo.peerCertificates[0].issuerDN.name (string) – (optional in query)

• sslInfo.peerCertificates[0].issuerUniqueID (array) – (optional in query)

• sslInfo.peerCertificates[0].issuerX500Principal.encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].issuerX500Principal.name (string) – (optional in query)

• sslInfo.peerCertificates[0].keyUsage (array) – (optional in query)

• sslInfo.peerCertificates[0].notAfter (string) – (optional in query)

• sslInfo.peerCertificates[0].notBefore (string) – (optional in query)

• sslInfo.peerCertificates[0].serialNumber (integer) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgName (string) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgOID (string) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgParams (string) – (optional in query)

• sslInfo.peerCertificates[0].signature (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectDN.name (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectUniqueID (array) – (optional in query)

• sslInfo.peerCertificates[0].subjectX500Principal.encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectX500Principal.name (string) – (optional in query)

• sslInfo.peerCertificates[0].type (string) – (optional in query)

• sslInfo.peerCertificates[0].version (integer) – (optional in query)

• sslInfo.sessionId (string) – (optional in query)

async idem_vra.exec.vra.abx.actionruns.get_by_id_using_get1(hub, ctx, p_id, **kwargs)

Fetch an action run by its ID Retrieves an action run entity with a specific ID Performs GET /abx/api/resources/action-runs/{id}

Parameters:

p_id (string) – (required in path) ID of the action run

async idem_vra.exec.vra.abx.actionruns.run_using_post(hub, ctx, p_id, **kwargs)

Trigger an action run Runs the specified action taking into consideration the supplied configuration Performs POST /abx/api/resources/actions/{id}/action-runs

Parameters:

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

• actionId (string) – (optional in body) ID of the action

• actionType (string) – (optional in body) Type of the action

• actionVersionId (string) – (optional in body) ID of the action version used for the execution

• actionVersionName (string) – (optional in body) Name of the action version used for the execution

• configuration (object) – (optional in body) Configuration of the action run for specific providers

• createdMillis (integer) – (optional in body) Creation time in millis

• endTimeMillis (integer) – (optional in body) Completion time in millis

• errorMessage (string) – (optional in body) Error message in case the run completed with an error

• id (string) – (optional in body) ID of the resource

• inputs (object) – (optional in body) Input parameters of the action

• logs (string) – (optional in body) Action run logs

• name (string) – (optional in body) Name of the resource

• orgId (string) – (optional in body) Org ID of the resource

• outputs (object) – (optional in body) Output parameters generated by the action

• projectId (string) – (optional in body) Project Id of the action (required for non-system actions)

• provider (string) – (optional in body) Provider used for code execution

• runProjectId (string) – (optional in body) Project Id where the project will be executed (required for non-system actions)

• runState (string) – (optional in body) State of the action run

• runtime (string) – (optional in body) Runtime of the action run (python, nodejs, etc…)

• scalable (boolean) – (optional in body)

• source (string) – (optional in body) Source used for the execution

• startTimeMillis (integer) – (optional in body) Start time in millis

• system (boolean) – (optional in body)

• timeoutSeconds (integer) – (optional in body) Timeout in seconds for execution

• triggeredBy (string) – (optional in body) The user who triggered the action run