apm resource webtop

apm resource webtop(1)				  BIG-IP TMSH Manual			       apm resource webtop(1)

NAME
       webtop - Configures a webtop resource.

MODULE
       apm resource

SYNTAX
       Configure the webtop component within the resource module using the syntax shown in the following sections.

   CREATE/MODIFY
	create webtop [name]
	modify webtop [name]
	  options:
	    app-service [[string] | none]
	    customization-group [string]
	    description [[string] | none]
	    location-specific [true | false]
	    minimize-to-tray [false | true]
	    portal-access-start-uri [[string] | none]
	    webtop-type [full | last | network-access | portal-access]
	    warn-when-closed [false | true]

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

   DISPLAY
	list webtop
	list webtop [ [ [name] | [glob] | [regex] ] ... ]
	show running-config webtop
	show running-config webtop [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line

	show webtop
	show webtop [name]

   DELETE
	delete webtop [name]

DESCRIPTION
       Configures the settings necessary to define the webtop assigned to the end-user as part of the access policy
       execution.

EXAMPLES
       create webtop mynawebtop { customization-group mywebtopcg1 minimize-to-tray false }
	    Creates a webtop named mynawebtop with the customization group mywebtopcg1 and the network access
	    minimize-to-tray option set to false.

       create webtop mywawebtop { customization-group mywebtopcg1 portal-access-start-uri
       '"http://www.siterequest.com"'  }
	    Creates a webtop named mywawebtop with the customization group mywebtopcg1 and the starting URI for the
	    portal access of http://www.siterequest.com.

OPTIONS
       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.

       customization-group
	    Specifies the customization settings for the webtop.

	    Note: You must create a customization group of type webtop before you can create a webtop resource. This
	    option is required.

       description
	    Specifies a description of the resource. The default is none.

       portal-access-start-uri
	    Specifies the URI that the webtop starts. You can only configure this option if you have configured the
	    webtop-type option for portal-access.

       location-specific
	    Specifies whether or not this object contains one or more attributes with values that are specific to the
	    location where the BIG-IP device resides. The location-specific attribute is either true or false. When
	    using policy sync, mark an object as location-specific to prevent errors that can occur when policies
	    reference objects, such as authentication servers, that are specific to a certain location.

       minimize-to-tray
	    Specifies whether the network access window (launched from the full webtop) is minimized to the system
	    tray automatically after the network access connection starts. The default is true.

	    You can configure this option only if you configured the webtop-type option as network-access or full.
	    With a network access webtop, the webtop automatically minimizes to the tray. With a full webtop, the
	    webtop minimizes to the system tray only after the network access connection is started.

       warn-when-closed
	    Specifies whether the network access window (launched from the full webtop) should display a warning
	    message when the webtop closes.

	    You can configure this option only if you configured the webtop-type option as full.

       webtop-type
	    Specifies the type of webtop this resource creates. The options are:

	    full A webtop to which you assign a single network access resource, multiple portal access resources, and
		 multiple application access app tunnel resources, or any combination of the three types. This is the
		 default.

	    last
	    network-access
		 A webtop to which you assign only a single network access resource.

	    portal-access
		 A webtop to which you assign only portal access resources.

SEE ALSO
       tmsh

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						      2014-01-21			       apm resource webtop(1)