apm policy agent variable-assign

apm policy agent variable-assign(1)			BIG-IP TMSH Manual		       apm policy agent variable-assign(1)

NAME
       variable-assign - Manages a Variable Assignment agent.

MODULE
       apm policy agent

SYNTAX
       Configure the variable-assign component within the policy agent module using the syntax shown in the following sections.

   CREATE/MODIFY
	create variable-assign [name]
	modify variable-assign [name]
	  options:
	    app-service [[string] | none]
	    type [citrix-smart-access | general | intranet-webtop | sso-cred-mapping | virtual-keyboard]
	    variables { [varname [name] expression {[string] }}

	edit variable-assign [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list variable-assign
	list variable-assign [ [ [name] | [glob] | [regex] ] ... ]
	show running-config variable-assign
	show running-config variable-assign  [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    partition

	show variable-assign
	show variable-assign [name]

   DELETE
	delete variable-assign [name]

DESCRIPTION
       You can use the variable-assign component to create and manage an agent that assigns one or more variables to an access
       policy. F5 Networks recommends that you use the visual policy editor to create complex variable assignments.

EXAMPLES
       create variable-assign username_variable_assign_ag { variables { varname "session.logon.last.username" expression "{[mcget
       {session.ssl.cert.cn}]}" } }
	    Creates the username_variable_assign_ag Variable Assignment agent that automatically assigns the value of the common
	    name field in the client certificate to the username field of the logon page. This is useful when an access policy
	    contains the Variable Assignment agent between the client certification and the AAA Active Directory server query
	    actions.

       create variable-assign acl_variable_assign_ag { variables { varname
       "config.connectivity_resource_network_access.MyprofileNR2.acl_name" expression "expr {\"MY_ACL1\"}" } }
	    Creates a Variable Assignment agent that carries out a configured ACL when a particular branch in the access policy is
	    followed, using the Variable Assignment agent to populate the appropriate variables with the ACL name.

       show variable-assign
	    Displays a list of Variable Assignment agents.

       delete variable-assign MyAssignVariableAgent delete
	    Deletes the Variable Assignment agent named MyAssignVariableAgent.

OPTIONS
       [name]
	    Specifies the name of a Variable Assignment agent. This setting is required.

       partition
	    Displays the partition within which the component resides.

       app-service
	    Specifies the name of the application service to which the object belongs. The default value is none. Note: If the
	    strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
	    object. Only the application service can modify or delete the object.

       type Specifies the type of agent. The default is general.

       variables
	    Adds a variable to or deletes a variable from the Variable Assignment agent. You must specify the following attributes
	    for each variable:

	    expression
		 A Tcl expression that the system evaluates, and then assigns the value of the expression to a specific property
		 of the assigned Network Access resource or to a newly created session variable.

	    varname
		 A variable that forms the left-hand side of the expression. You can use the name of an existing variable or a new
		 session variable.

SEE ALSO
COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
       photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
       use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2011-2012. All rights reserved.

BIG-IP							    2012-12-20			       apm policy agent variable-assign(1)