Share via

Provisioning Schema::queue

  • Article

Element that encapsulates procedure steps intended for delayed execution. This element is part of the provisioning schema of Microsoft Provisioning Framework (MPF).

Arguments

Input Argument Description

Provisioning Schema::after

(minOccurs="0" maxOccurs="*")

Provisioning Schema::before

(minOccurs="0" maxOccurs="*")

Provisioning Schema::executeData

(minOccurs="0" maxOccurs="1")

Provisioning Schema::forEach

(minOccurs="0" maxOccurs="*")

Provisioning Schema::repeat

(minOccurs="0" maxOccurs="*")

Provisioning Schema::when

(minOccurs="0" maxOccurs="*")

impersonate

Optional. Enumeration that indicates whether to use impersonation for the procedure call. Impersonation is the ability of a procedure to execute using the credentials specified in the security context of another user account or (if there are no credentials) the calling user's identity. The default user account for MPF processing is MPFServiceAcct, which has only a limited range of security privileges. However, when MPF is configured to support impersonation, MPF can use any procedures available to the calling user or to a user whose credentials are defined in the configuration database.

  • 0 (default): MPF executes calls based on the impersonate value inherited from the calling procedure.

  • 1: Impersonation is enabled. MPF executes calls based on the credentials in the security context or the calling user's credentials.

  • 2: Impersonation is disabled. MPF executes calls using the identity under which the provisioning engine is running. By default, this identity is MPFServiceAcct.

namespace

Required. Namespace that implements the procedure.

procedure

Required. Name of the procedure.

queueSuspended

Optional. Boolean that specifies how a procedure is submitted to the Queue Manager.

  • 0: The procedure is submitted in activated mode.

  • 1 (default): The procedure is submitted in suspended mode.

A suspended procedure is activated when the transaction completes successfully; otherwise, it is deleted from the queue. In contrast, a non-suspended queued procedure always executes regardless of whether the corresponding transaction completes successfully.

sensitive

Optional. Enumeration that specifies whether the provisioning engine encrypts rollback data in a Transaction Logs [HMC SDK].

  • 0 (default): MPF executes calls based on the sensitive value inherited from the calling procedure.

  • 1: MPF encrypts data, starting with the current level and carrying over to all subsequent substeps, until an explicit value "2" is encountered.

  • 2: MPF does not encrypt data. A "2" setting at any level of the tree carries over to subsequent substeps, until it is overridden by a "1."

trusted

Optional. Enumeration that specifies whether MPF passes the security context Provisioning Schema::authentication node to the called procedure. This attribute allows the procedure writer to control access to authentication credentials from the called procedure.

  • 0 (default): MPF executes calls based on the trusted value inherited from the calling procedure.

  • 1: MPF passes the authentication node to the called procedure.

  • 2: MPF does not pass the authentication node to the called procedure.

Remarks

If a queue node is specified, the procedure identified by the procedure and namespace attributes is queued for execution, and the Provisioning Queue Manager Service [HMC SDK] generates a queueId attribute for the request's Provisioning Schema::queueContext node.

The queue node is useful for failure handling for synchronous requests. If a request fails, the failed step(s) can be queued for retry.

Note

  • To retrieve the queueId for a procedure/queue node using an Provisioning Schema::after transformation, set the source attribute to "context" instead of "executeData." Queued requests are asynchronous, so they do not return Provisioning Schema::executeData nodes.

  • The queue node does not offer the same functionality as the IProvQueue interface. For example, queue does not support submitting suspended requests or defining dependencies between suspended requests.

Sample Code

Example XML Request

<request> 
  <procedure> 
    <queue namespace='Active Directory Provider' procedure='Path To DN' queueSuspended='0'> 
      <executeData><path>LDAP://cn=MapsServiceAcct,cn=Users,dc=xzy2b-dom,dc=extest,dc=microsoft,dc=com</path> 
      </executeData> 
    <after source='context' destination='data'/> 
    </queue> 
  </procedure> 
</request>

Applies To

Provisioning Schema; Provisioning Schema::catch; Provisioning Schema::procedure; Provisioning Schema::try

See also

Tasks

Provisioning Schema::catch
Provisioning Schema::procedure
Provisioning Schema::try
Provisioning Schema::queueContext
Provisioning Schema::after
Provisioning Schema::before
Provisioning Schema::executeData
Provisioning Schema::forEach
Provisioning Schema::repeat
Provisioning Schema::when

Other Resources

Provisioning Queue Manager Service [HMC SDK]