actions#

async idem_vra.exec.vra.abx.actions.create_using_post(hub, ctx, actionType, name, orgId, **kwargs)[source]#

Create an action Creates a new action Performs POST /abx/api/resources/actions

Parameters:

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

  • name (string) – (required in body) Name of the action

  • orgId (string) – (required in body) Organization ID of the action.

  • asyncDeployed (boolean) – (optional in body)

  • compressedContent (string) – (optional in body) base64encoded ZIP of action content (source & dependencies)

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

  • contentId (string) – (optional in body) ID of the actions saved compressed content

  • dependencies (string) – (optional in body) A list of libraries to import, delimited by a comma

  • description (string) – (optional in body) Description of the action

  • entrypoint (string) – (optional in body) Name of the entry function of the action

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

  • inputs (object) – (optional in body) Map defining the inputs of the action

  • memoryInMB (integer) – (optional in body) Runtime RAM constraints in megabytes

  • metadata (object) – (optional in body) Additional properties used by ABX

  • prePolyglotMemoryLimitInMB (integer) – (optional in body)

  • 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

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

  • scalable (boolean) – (optional in body)

  • selfLink (string) – (optional in body)

  • shared (boolean) – (optional in body) Flag indicating if the action can be shared across projects.

  • showMemoryAlert (boolean) – (optional in body)

  • source (string) – (optional in body) Source of the action as string

  • system (boolean) – (optional in body) Flag indicating if the action is a system action.

  • timeoutSeconds (integer) – (optional in body) Defines how long an action can run (default 600)

async idem_vra.exec.vra.abx.actions.delete_using_delete1(hub, ctx, p_id, q_projectId, **kwargs)[source]#

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

Parameters:

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

  • q_projectId (string) – (required in query) Project ID of action (required for non-system actions)

  • force (boolean) – (optional in query) force

async idem_vra.exec.vra.abx.actions.delete_using_delete(hub, ctx, **kwargs)[source]#

Delete multiple actions by their id and projectId Deletes actions with a specific ID and projectId Performs DELETE /abx/api/resources/actions

async idem_vra.exec.vra.abx.actions.export_using_post(hub, ctx, actions, **kwargs)[source]#

Export actions Exports the specified actions as a zip bundle Performs POST /abx/api/resources/actions/export

Parameters:

actions (array) – (required in body) List of the identities of the actions to export

async idem_vra.exec.vra.abx.actions.get_all_flows_using_action_using_get(hub, ctx, p_id, **kwargs)[source]#

Fetch all action flows using an action Retrieves a list of all action flows which are using the specified action Performs GET /abx/api/resources/actions/{id}/flows

Parameters:

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

  • projectId (string) – (optional in query) Project ID of action (required for non-system actions)

async idem_vra.exec.vra.abx.actions.get_all_using_get(hub, ctx, **kwargs)[source]#

Fetch all actions Retrieves all action entities Performs GET /abx/api/resources/actions

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.actions.get_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

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

Parameters:

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

  • projectId (string) – (optional in query) Project ID of action (required for non-system actions)

async idem_vra.exec.vra.abx.actions.import_actions_using_post(hub, ctx, **kwargs)[source]#

Import an action bundle Imports an action bundle and saves all actions Performs POST /abx/api/resources/actions/import

Parameters:

  • bundleId (string) – (optional in body) ID of the saved bundle used for import conflict resolution

  • compressedBundle (string) – (optional in body) base64encoded ZIP bundle of actions to import

  • option (string) – (optional in body) Conflict option when importing (CREATE on initial import)

  • projectId (string) – (optional in body) Project ID for where to create the actions

  • system (boolean) – (optional in body) Flag indicating if the imported actions should be system actions

async idem_vra.exec.vra.abx.actions.patch_using_patch(hub, ctx, p_id, actionType, name, orgId, **kwargs)[source]#

Patch an action Updates the state of the action based only on the supplied properties Performs PATCH /abx/api/resources/actions/{id}

Parameters:

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

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

  • name (string) – (required in body) Name of the action

  • orgId (string) – (required in body) Organization ID of the action.

  • asyncDeployed (boolean) – (optional in body)

  • compressedContent (string) – (optional in body) base64encoded ZIP of action content (source & dependencies)

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

  • contentId (string) – (optional in body) ID of the actions saved compressed content

  • dependencies (string) – (optional in body) A list of libraries to import, delimited by a comma

  • description (string) – (optional in body) Description of the action

  • entrypoint (string) – (optional in body) Name of the entry function of the action

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

  • inputs (object) – (optional in body) Map defining the inputs of the action

  • memoryInMB (integer) – (optional in body) Runtime RAM constraints in megabytes

  • metadata (object) – (optional in body) Additional properties used by ABX

  • prePolyglotMemoryLimitInMB (integer) – (optional in body)

  • 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

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

  • scalable (boolean) – (optional in body)

  • selfLink (string) – (optional in body)

  • shared (boolean) – (optional in body) Flag indicating if the action can be shared across projects.

  • showMemoryAlert (boolean) – (optional in body)

  • source (string) – (optional in body) Source of the action as string

  • system (boolean) – (optional in body) Flag indicating if the action is a system action.

  • timeoutSeconds (integer) – (optional in body) Defines how long an action can run (default 600)

async idem_vra.exec.vra.abx.actions.update_using_put(hub, ctx, p_id, actionType, name, orgId, **kwargs)[source]#

Update an action Updates the action with the new supplied state Performs PUT /abx/api/resources/actions/{id}

Parameters:

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

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

  • name (string) – (required in body) Name of the action

  • orgId (string) – (required in body) Organization ID of the action.

  • asyncDeployed (boolean) – (optional in body)

  • compressedContent (string) – (optional in body) base64encoded ZIP of action content (source & dependencies)

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

  • contentId (string) – (optional in body) ID of the actions saved compressed content

  • dependencies (string) – (optional in body) A list of libraries to import, delimited by a comma

  • description (string) – (optional in body) Description of the action

  • entrypoint (string) – (optional in body) Name of the entry function of the action

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

  • inputs (object) – (optional in body) Map defining the inputs of the action

  • memoryInMB (integer) – (optional in body) Runtime RAM constraints in megabytes

  • metadata (object) – (optional in body) Additional properties used by ABX

  • prePolyglotMemoryLimitInMB (integer) – (optional in body)

  • 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

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

  • scalable (boolean) – (optional in body)

  • selfLink (string) – (optional in body)

  • shared (boolean) – (optional in body) Flag indicating if the action can be shared across projects.

  • showMemoryAlert (boolean) – (optional in body)

  • source (string) – (optional in body) Source of the action as string

  • system (boolean) – (optional in body) Flag indicating if the action is a system action.

  • timeoutSeconds (integer) – (optional in body) Defines how long an action can run (default 600)