VISULOX-PORTAL OBJECT Command

visulox-portal object

The visulox-portal object command enables you to create, list, edit, and delete objects in the organizational hierarchy.

You can also add and remove assigned applications links, configure application server load balancing for each application, and add and remove group members.

Syntax

CODE

visulox-portal object add_host | add_link | add_mapping | add_member |
delete | edit | list_attributes | list_contents |new_charapp | new_container | 
new_dc | new_doc | new_dynamicapp | new_group | new_host | new_org |
new_orgunit | new_person | new_windowsapp | new_xapp | remove_host | 
remove_link | remove_mapping | remove_member | rename | script

Description

Available subcommands for this command.

CODE

add_host 		Adds application servers to the lst of those that can run an application.
add_link 		Adds assigned applications links.
add_member 		Adds members to a group.
delete 			Permanently deletes objects from the organizational hierarchy.
edit 			Edits attributes for an object
list_attributes Lists attributes of an object.
list_contents 	Lists the contents of container object, such as an OU or an organization.
new_charapp 	Creates character application objects.
new_container 	Creates Active Directory container objects.
new_dc 			Creates domain component objects.
new_doc			Creates document objects.
new_group 		Creates group objects
new_host 		Creates application server objects.
new_org 		Creates organization objects.
new_orgunit 	Creates organizational unit objects.
new_person 		Creates user profile objects.
new_windowsapp 	Creates Windows application objects.
new_xapp 		Creates X application objects
remove_host 	Removes application servers from those that can run an application.
remove_link 	Removes assigned applications links
remove_mapping 	Removes mappings for a dynamic application
remove_member 	Removes members from groups.
rename 			Renames or moves an object.
script 			Runs a batch script of object commands

All commands include a --help option. You can use visulox-portal object subcommand --help to get help on a specific command.

Examples

The following example lists the objects that belong to the organizational unit Sales.

CODE

visulox-portal object list_contents --name "o=Example/ou=Sales"

Naming Objects in the Organizational Hierarchy

When an object is created in the VISULOX Portal Console, any characters can be chosen for the name of the object, apart from backslash (\) or plus (+).

On the command line, if a forward slash is used in an object name, backslash protect is needed, or it has to be escaped. This is because VISULOX Portal interprets the forward slash as a part of the organizational hierarchy.
For example, if an object should be created with the relative name cn=a/b beneath o=organization, the portal tries to create an object called b within o=organization/cn=a.
This fails because o=organization/cn=a does not exist. To create an object with this name, enter cn=a\/b.

On the command line, if the name of an object includes spaces, make sure the name is enclosed in quotes, for example ".../_ens/o=Example Organization".

With the tarantella object command, any name in the local repository is treated as case insensitive.

When you create or rename an object, the case used is preserved. However, other commands, such as the tarantella webtopsession and tarantella emulatorsession commands, are case sensitive.

visulox-portal object add_host

Adds application servers to the list of those that can run an application, for application server load balancing.

Syntax

CODE

visulox-portal object add_host { --name obj... --host hobj... } | --file file

Description

Available options for this command.

CODE

--name 	The names of application objects you want to configure load balancing for.
--host 	The names of application server objects you want to add to the load balancing pool.
--file 	A file containing a batch of commands to configure application server load balancing.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example adds the application server rome to the load balancing pool for the application Slide-o-Win.

CODE

visulox-portal object add_host --name "o=applications/cn=Slide-o-Win" --host "o=appservers/ou=Sales/cn=rome"

The following example adds the group WinHosts to the load balancing pool for the applications Write-o-Winand Slide-o-Win.
Load balancing is performed across all the application servers in WinHosts.

CODE

visulox-portal object add_host --name "o=applications/cn=Write-o-Win" "o=applications/cn=Slide-o-Win" --host "o=appservers/cn=WinHosts"

visulox-portal object add_link

Adds assigned applications links for an object.

Syntax

CODE

visulox-portal object add_link { --name obj... --link lobj... } | --file file

Description

Available options for this command.

CODE

--name 	The names of objects you want to add assigned applications links for.
--link 	The names of assigned applications links you want to add.
--file 	A file containing a batch of commands to add assigned applications links.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example adds the Write-o-Win application to Violet Carson's assigned applications.

CODE

visulox-portal object add_link --name "o=Example/ou=Sales/cn=Violet Carson"  --link "o=applications/cn=Write-o-Win"

The following example adds the group Applications to the assigned applications of the organizational units Sales and Marketing.
Everyone who inherits assigned applications from one of these OUs, for example, they belong to that OU and inherit assigned applications from parent
is selected for their user profile object, sees all the applications in the group in their assigned applications.

CODE

visulox-portal object add_link --name "o=Example/ou=Sales" --name "o=Example/ou=Marketing" --link "o=applications/cn=Applications"

visulox-portal object add_member

Adds objects to groups.

Syntax

CODE

visulox-portal object add_member { --name obj... --member mobj... } | --file file

Description

Available options for this command.

CODE

--name 		Specifies the names of group objects you want to add members for.
--member 	Specifies the names of objects you want to add to the groups.
--file 		Specifies a file containing a batch of commands to add group members.

CODE

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example adds the Write-o-Win application to the group Applications.

CODE

visulox-portal object add_member --name "o=applications/cn=Applications" --member "o=applications/cn=Write-o-Win"

The following example adds the three application server objects rome, brussels, and berlin to the group WinHosts.
This group can be added to an application's Hosting applications Servers Tab to perform load balancing between the application servers.
From the command line, use visulox-portal object add host.

CODE

visulox-portal object add_member --name "o=appservers/cn=WinHosts" --member "o=appservers/ou=Sales/cn=rome" \
"o=appservers/cn=brussels" "o=appservers/ou=Marketing/cn=berlin"

visulox-portal object delete

Permanently deletes objects from the organizational hierarchy.

Syntax

CODE

visulox-portal object delete { --name obj [ --children ] } | --file file

Description

Available options for this command.

CODE

--name 		Specifies the name of the object you want to delete.
--children 	When deleting organizational units, Active Directory containers or domain components, confirms that you want to 
			delete the object and all objects that belong to it, recursively. As a afeguard, it is impossible to delete an 
			organizational unit, Active Directory container or domain component without specifying --children.
--file 		Specifies a file containing a batch of commands to delete objects.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example removes the user profile object for Violet Carson.

CODE

visulox-portal object delete --name "o=Example/ou=Sales/cn=Violet Carson"

The following example deletes the organizational unit Sales.

CODE

visulox-portal object delete --name "o=Example/ou=Sales" --children

visulox-portal object edit

Edits the attributes of an object in the organizational hierarchy.

Syntax

CODE

visulox-portal object edit { --name obj { --attribute [value] }... } | --file file

Description

Available options for this command.

CODE

--name 						Specifies the name of the object you want to edit the attributes of.
{--attribute [value]}... 	Specifies the attribute names you want to edit, and their new values.
							The valid attributes depend on the type of object. 
							See the visulox-portal object new_object_type documentation for the appropriate list.
							For example, when editing attributes for an application object you can specify --displayusing 
							to edit the attribute. If you omit value for an attribute, it is deleted from the object.
--file 						Specifies a file containing a batch of commands to edit attributes.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example changes the “Inherit Assigned Applications from Parent” attribute for the organizational unit Sales.

CODE

visulox-portal object edit --name "o=Example/ou=Sales" --inherit false

visulox-portal object list_attributes

Lists the attributes of an object in the organizational hierarchy.

Syntax

CODE

visulox-portal object list_attributes { --name obj [ --attribute... ]} | --file file

Description

Available options for this command.

CODE

--name 						Specifies the name of the object you want to list the attributes of.
{--attribute [value]}... 	Specifies the attribute names you want to list. The valid attributes depend on the type of object. 
							See the visulox-portal object new_object_type documentation for the appropriate list.
							For example, when listing attributes for an application object you can specify --displayusing to edit the attribute.
--file 						Specifies a file containing a batch of commands to list attributes.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example lists all attributes for the Sales organizational unit.

CODE

visulox-portal object list_attributes --name "o=Example/ou=Sales"

The following example lists the Email Address and Login attributes for the user profile object for Rusty Spanner.

CODE

visulox-portal object list_attributes --name "o=Example/ou=IT/cn=Rusty Spanner" --email –enabled

visulox-portal object list_contents

Lists the objects that belong to a container object in the organizational hierarchy, such as an organization or organizational unit (OU).

Syntax

CODE

visulox-portal object list_contents { --name obj }| --file file

Description

Available options for this command.

CODE

--name 	Specifies the name of the object you want to list the contents of.
--file 	Specifies a file containing a batch of commands to list object contents.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example lists all the objects within the organizational unit Sales.

CODE

visulox-portal object list_contents --name "o=Example/ou=Sales"

visulox-portal object new_charapp

Creates one or more character application objects.

Syntax

CODE

visulox-portal object new_charapp {
--name obj
--emulator scocon|vt420|wyse60
--termtype type
--width pixels
--height pixels
[ --description text ]
[ --app pathname ]
[ --args args ]
[ --appserv obj... ]
[ --method telnet|ssh ]
[ --resumable never|session|always ]
[ --maxinstances 0|instances ]
[ --displayusing independent|kiosk ]
[ --maximize true|false ]
[ --cols cols ]
[ --lines lines ]
[ --icon icon_name ]
[ --hints hint...]
[ --font courier|helvetica|timesroman ]
[ --fontsize points ]
[ --fixedfont true|false ]
[ --autowrap true|false ]
[ --cursor off|block|underline ]
[ --statusline none|indicator|hostmessages|standard|extended ]
[ --scrollstyle line|multiple|smooth ]
[ --border normal|indented|raised ]
[ --answermsg message ]
[ --appkeymode true|false ]
[ --keypad numeric|application ]
[ --cursorkeys application|cursor ]
[ --escape 7-bit|8-bit ]
[ --codepage 437|850|852|860|863|865|8859-1|8859-2|Multinational|Mazovia|CP852 ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
[ --loadbal default|cpu|memory|sessions ]
[ --compression automatic|on|off ]
[ --env setting... ]
[ --login script ]
[ --keymap keymap ]
[ --attributemap attrmap ]
[ --colormap colormap ]
[ --resumetimeout mins ]
[ --windowclose suspendsession|endsession ]
[ --ssharguments args ]
} | --file file

Description

Available options for this command.

CODE

--name 			The common name of the object in the datastore.
--emulator 		The type of emulation required for the application.
--termtype 		The terminal type required for the application.
--width 		The width of the application, in pixels.
--height 		The height of the application, in pixels.
--description 	A text description of the object.
--app 			Full path name of the application.
--args 			The command-line arguments to use when starting the application.
--appserv 		The application servers that can run the application.
--method 		The mechanism used by the VISULOX Portal server to access the application server and start the application.
--resumable 	Resumability behavior for the application.
--maxinstances 	The maximum number of instances of the application a user can run simultaneously.
--displayusing 	How the application is displayed to the user.
--maximize 		The initial size of the application.
--cols 			The number of columns in the terminal window.
--lines 		The number of lines in the terminal window.
--icon 			Workspace icon for the application.
--hints 		String containing additional name-value data for the application.
--font 			Determines the font family used within the terminal window for the application
--fontsize 		Defines the font size in the terminal window.
--fixedfont 	Uses the font size specified by --fontsize for the terminal window.
--autowrap 		Determines the behavior when a user types characters extending beyond the right edge of the terminal window.
--cursor 		Cursor style used for the application.
--statusline 	Specifies the type of status line.
--scrollstyle 	The scroll behavior of the terminal window.
--border 		The border style for the terminal window.
--answermsg 	Defines the message to return when an inquiry is sent from the application server to the emulator.
--appkeymode 	Determines whether the application can change the codes generated by keys on the keyboard.
--keypad 		Specifies the behavior of the cursor keys
--cursorkeys 	Specifies the behavior of the cursor keys.
--escape 		Specifies how escape sequences are sent from the emulator to the application server.
--codepage 		The code page to use for the emulator.
--ldapusers 	Assigns the application to the specified LDAP users.
--ldapgroups 	Assigns the application to the specified LDAP groups.
--ldapsearch 	Assigns the application to the users that match the LDAP search criteria.
--loadbal 		Load balancing algorithm to use.
--compression 	Whether the AIP protocol compresses commands for transmission.
--env 			Environment variable settings needed to run the application.
--login 		The login script used to start the application.
--keymap 		Path name of a keyboard map file.
--attributemap 	The attribute map to use for the application.
--colormap 		The color map to use for the application.
--resumetimeout Number of minutes the application is resumable for.
--windowclose 	Effect on application session of closing the main application window.
--ssharguments 	Command-line arguments for the ssh client.
--file 			Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a character application object for the application Pers-o-dat.
The application can be run on the application servers prague and london. Application server load balancing decides which application server to use.

CODE

visulox-portal object new_charapp --name "o=applications/cn=Pers-o-dat" --emulator vt420 --termtype vt220 \
--width 400 --height 300 --app /bin/persodat --appserv "o=appservers/cn=prague" "o=appservers/ou=IT/cn=london"

visulox-portal object new_container

Creates one or more Active Directory container objects.

Syntax

CODE

visulox-portal object new_container { --name obj } | --file file

Description

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new Active Directory container object with name Users, within the example.com domain components.

CODE

visulox-portal object new_container --name "dc=com/dc=example/cn=Users"

The following example creates two Active Directory container objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_container --file - <<EOF
--name "dc=com/dc=example/cn=Users"
--name "dc=com/dc=example/cn=Applications"
EOF

visulox-portal object new_dc

Creates one or more domain component objects.

Syntax

CODE

visulox-portal object new_dc { --name obj } | --file file

Description

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new domain component object with name com, at the top level of the organizational hierarchy.

CODE

visulox-portal object new_dc --name "dc=com"

The following example creates two domain component objects using a batch script defined as a “heredocument”.

You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_dc --file - <<EOF
--name "dc=com"
--name "dc=com/dc=example"
EOF

visulox-portal object new_doc

Creates one or more document objects.

Syntax

CODE

visulox-portal object new_doc {
--name obj
--url url
[ --description text ]
[ --newbrowser true|false ]
[ --icon icon_name ]
[ --hints hint...]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
} | --file file

Description

Available options for this command.

CODE

--name 			The name of the document object.
--url 			URL displayed when document object link is clicked.
--description	A text description of the object.
--newbrowser 	Displays the document in a new browser window.
--icon 			Workspace icon for the application.
--hints 		String containing additional name-value data for the application.
--ldapusers 	Assigns the application to the specified LDAP users.
--ldapgroups 	Assigns the application to the specified LDAP groups.
--ldapsearch 	Assigns the application to the users that match the LDAP search criteria.
--file 			A file containing a batch of commands to configure application server load balancing.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new document object named PhoneList.

CODE

visulox-portal object new_doc \
--name "o=applications/ou=Finance/ou=Administration/cn=Phone List" \
--url http://newyork.example.com \
--newbrowser false

The following example creates two document objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_doc --file - <<EOF
--name "o=applications/ou=Finance/ou=Administration/cn=Phone List"
--url http://newyork.example.com
--newbrowser false
--name "o=applications/cn=Example web site"
--url http://www.example.com
--newbrowser true
EOF

visulox-portal object new_group

Creates one or more group objects.

Syntax

CODE

visulox-portal object new_group {
--name obj
[ --description text ]
[ --member obj... ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
} | --file file

Description

Available options for this command.

CODE

--name 			The name of the group object.
--description 	A text description of the object.
--member 		Member of the group object.
--ldapusers 	Assigns the application to the specified LDAP users.
--ldapgroups 	Assigns the application to the specified LDAP groups.
--ldapsearch 	Assigns the application to the users that match the LDAP search criteria.
--file 			A file containing a batch of commands to configure application server load balancing.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new group object with common name WinHosts, belonging to the organization object appservers.
The group's members are the application server objects for the application servers rome, brussels, and berlin.

CODE

visulox-portal object new_group --name "o=appservers/cn=WinHosts" \
--member "o=appservers/ou=Sales/cn=rome" "o=appservers/cn=brussels" \
"o=appservers/ou=Marketing/cn=berlin"

The following example creates three group objects using a batch script defined as a “here-document”. The groups have no members. You can use “visulox-portal object add member” to add members

later from the command line. You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_group --file - <<EOF
visulox-portal object new_host
--name "o=appservers/cn=WinHosts"
--name "o=appservers/cn=UNIXHosts"
--name "o=applications/cn=Applications"
EOF

visulox-portal object new_host

Creates one or more of the following objects:

Application server.
Dynamic application server.
Oracle VM hypervisor host.
VirtualBox hypervisor host.

Syntax

For an application server object, use the following syntax:

CODE

visulox-portal object new_host {
--name obj
[ --address address ]
[ --description text ]
[ --ntdomain dom ]
[ --available true|false ]
[ --auth trytta|nevertrytta|default ]
[ --location location ]
[ --hostlocale ll_tt ]
[ --maxcount count ]
[ --userassign spec ]
[ --sgdpermittedauthtypes types ]
} | --file file

For a dynamic application server object, use the following syntax:

CODE

visulox-portal object new_host {
--name obj
--dynamic
[ --description text ]
[ --auth trytta|nevertrytta|default ]
[ --vsbclass classname ]
[ --vsbparams params ]
[ --sgdpermittedauthtypes types ]
} | --file file

For an Oracle VM hypervisor host object, use the following syntax:

CODE

visulox-portal object new_host {
--name obj
--address address
--ovm
[ --description text ]
[ --available true|false ]
[ --auth trytta|nevertrytta|default ]
[ --vmsubnet network-address/mask ]
[ --ovmtags tag... ]
[ --ovmpools pool... ]
[ --ovmservers server-name... ]
[ --vmnames vm-name... ]
[ --vmostypes os-type... ]
[ --maxcount count ]
[ --userassign spec ]
[ --sgdpermittedauthtypes types ]
} | --file file

For a VirtualBox hypervisor host object, use the following syntax:

CODE

visulox-portal object new_host {
--name obj
--address address
--vbox
[ --description text ]
[ --available true|false ]
[ --auth trytta|nevertrytta|default ]
[ --vmsubnet network-address/mask ]
[ --vboxgroups group... ]
[ --vmnames vm-name... ]
[ --vmostypes os-type... ]
[ --maxcount count ]
[ --userassign spec ]
[ --sgdpermittedauthtypes types ]
} | --file file

Description

Available options for this command.

CODE

--name 					The names of objects you want to add assigned applications links for.
--address 				Network address of the application server. For hypervisor hosts, enter the web services URL.
--dynamic 				Create a dynamic application server.
--ovm 					Create an Oracle VM hypervisor host.
--vbox 					Create a VirtualBox hypervisor host.
--description 			A text description of the object.
--ntdomain 				The Windows domain used for application server authentication.
--available 			Specifies whether applications can run on this application server.
--auth 					Specifies the policy for authenticating users on the application server, if no password is already cached for that server.
--location 				String describing the location of the application server. Used for load balancing.
--hostlocale 			Default language setting for the application server.
--vsbclass 				Fully qualified class name for the virtual server broker (VSB). Dynamic application servers only.
--vsbparams 			Parameters passed to the VSB. Dynamic application servers only.
--vmsubnet 				Connect only to VMs which use an IP address on the specified subnet. Oracle VM hypervisor hosts and VirtualBox hypervisor hosts only.
--ovmtags 				Tags used for VM selection criteria. Oracle VM hypervisor hosts only.
--ovmpools 				Server pool names used for VM selection criteria. Oracle VM hypervisor hosts only.
--ovmservers 			Oracle VM Server names used for VM selection criteria. Oracle VM hypervisor hosts only.
--vmnames 				VM names used for VM selection criteria. Oracle VM hypervisor hosts and VirtualBox hypervisor hosts only.
--vmostypes 			Operating system (OS) types used for VM selection criteria. Oracle VM hypervisor hosts and VirtualBox hypervisor hosts only.
--vboxgroups 			Oracle VM VirtualBox groups used for VM selection criteria. VirtualBox hypervisor hosts only.
--maxcount 				Maximum number of application sessions that can be run concurrently on the application server.
--userassign 			Specifies the users that can run applications on the application server.
--sgdpermittedauthtypes Specifies the authentication methods which are allowed for this application server.
--file 					A file containing a batch of commands to add assigned applications links.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example creates a new application server object with common name paris, belonging to the organizational unit object Finance, which must already exist.

CODE

visulox-portal object new_host --name "o=appservers/ou=Finance/cn=paris" \
--address paris.example.com --auth default --location Europe-north

The following example creates a new dynamic application server object MyBroker that uses the Userdefined VISULOX Portal broker.

CODE

visulox-portal object new_host --dynamic --name "o=appservers/cn=MyBroker" \
--vsbclass com.sun.sgd.vsbim.UserDefinedSGDBroker

The following example creates a new dynamic application server object MyVDIBroker that uses the VDI broker. A list of preferredhosts is configured for the broker.

CODE

visulox-portal object new_host --dynamic --name "o=appservers/cn=MyVDIBroker" \
--vsbclass com.oracle.sgd.vsbim.OracleVDIVirtualServerBroker \
--vsbparams "preferredhosts=\"https://vdihost1.com:1802/client,https://vdihost2.com:1802/client,https://vdihost3.com:1802/client\""

The following example creates a new Oracle VM hypervisor object ovm1 that connects to the Oracle VM Manager host ovm-mgr.example.com on TCP port 7002.
Only VMs which have a tag of marketing or sales are used by VISULOX Portal.

CODE

visulox-portal object new_host --ovm --name "o=appservers/cn=ovm1" \
--address "https://ovm-mgr.example.com:7002/ovm/core/wsapi/rest" --ovmtags "marketing,sales"

The following example creates a new Oracle VM hypervisor object ovm1 that connects to the Oracle VM Manager host ovm-mgr.example.com on TCP port 7002.
Only VMs which have an IP address on the specified subnet are used by VISULOX Portal.

CODE

visulox-portal object new_host --ovm --name "o=appservers/cn=ovm1" \
--address "https://ovm-mgr.example.com:7002/ovm/core/wsapi/rest" --vmsubnet 192.0.2.0/24

The following example creates a new VirtualBox hypervisor object vbox1 that connects to the Oracle VM VirtualBox host vbox.example.com.
Only VMs which are members of the Oracle VM VirtualBox groups support or sales are used by VISULOX Portal.

CODE

visulox-portal object new_host --vbox --name "o=appservers/cn=vbox1" \
--address "https://vbox.example.com:18083" --vboxgroups "support,sales"

The following example creates three application server objects using a batch script defined as a “here-document”.
Alternatively, you can store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_host --file - <<EOF
--name "o=appservers/ou=Finance/cn=paris"
--address paris.example.com
--name "o=appservers/cn=brussels"
--address brussels.example.com
--name "o=appservers/ou=IT/cn=london"
--address london.example.com
EOF

visulox-portal object new_org

Syntax

Creates one or more organization objects.

CODE

visulox-portal object new_org {
--name obj
[ --description text ]
[ --conntype type_spec... ]
[ --cdm drive_spec... ]
[ --userprintingconfig true|false ]
[ --mapprinters 2|1|0 ]
[ --pdfenabled 1|0 ]
[ --pdfviewerenabled 1|0 ]
[ --pdfdriver driver_name ]
[ --pdfisdefault 1|0 ]
[ --pdfviewerisdefault 1|0 ]
[ --links obj... ]
[ --editprofile 2|1|0 ]
[ --clipboard 2|1|0 ]
[ --serialport 2|1|0 ]
} | --file file

Description

Available options for this command.

CODE

--name 					The name of the organization object in the VISULOX Portal datastore.
--description 			A text description of the object.
--conntype 				The connections that are allowed between the client device and the VISULOX Portal server.
--userprintingconfig 	Enables user-specific printing configuration.
--mapprinters 			The client printers users can print to when printing from Windows applications.
--pdfenabled 			Enables users to print using the VISULOX Portal “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled 		Enables users to print using the VISULOX Portal “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver 			The printer driver to use for VISULOX Portal PDFprinting when printing from Windows applications.
--pdfisdefault 			Sets the VISULOX Portal “Universal PDF Printer” printer as the client's default printer when printing from Windows applications.
--pdfviewerisdefault 	Sets the VISULOX Portal “Universal PDF Viewer” printer as the client's default printer when printing from Windows applications.
--links 				Defines assigned applications links.
--editprofile 			Whether users can create and edit profiles for use with the Native Client.
--clipboard 			Whether users can use copy and paste in Windows or X application sessions.
--serialport 			Whether users can access the serial ports on a client device from a Windows application.
--file 					Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new organization object with name Example.
Connections for all users in the organization are secure (SSL-based) unless the OU or user profile objects are configured to give a different type of connection.

CODE

visulox-portal object new_org --name "o=Example" --conntype '*:*:SSL'

The following example creates two organization objects using a batch script defined as a “here-document”.
You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_org --file - <<EOF
--name "o=Example"
--name "o=Example Services"
EOF

visulox-portal object new_orgunit

Creates one or more organizational unit (OU) objects

Syntax

CODE

visulox-portal object new_orgunit {
--name obj
[ --description text ]
[ --inherit true|false ]
[ --conntype type_spec... ]
[ --cdm drive_spec... ]
[ --userprintingconfig 1|0 ]
[ --mapprinters 2|1|0 ]
[ --pdfenabled 1|0 ]
[ --pdfviewerenabled 1|0 ]
[ --pdfdriver driver_name ]
[ --pdfisdefault 1|0 ]
[ --pdfviewerisdefault 1|0 ]
[ --links obj... ]
[ --editprofile 2|1|0 ]
[ --clipboard 2|1|0 ]
[ --serialport 2|1|0 ]
} | --file file

Description

The following table shows the available options for this command.

CODE

--name 					The name of the organizational unit object in the VISULOX Portal datastore.
--description 			A text description of the object.
--inherit 				Whether the assigned applications for the object also includes the assigned applications for the object's parent.
--conntype 				The connections that are allowed between the client device and the VISULOX Porion servers.
--userprintingconfig 	Enables user-specific printing configuration.
--mapprinters 			The client printers users can print to when printing from Windows applications.
--pdfenabled 			Enables users to print using the VISULOX Portal “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled 		Enables users to print using the VISULOX Portal “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver 			The printer driver to use for VISULOX Portal PDF printing when printing from Windows applications.
--pdfisdefault 			Sets the VISULOX Portal “Universal PDF Printer” printer as the client's default printer when printing from Windows applications.
--pdfviewerisdefault 	Sets the VISULOX Portal “Universal PDF Viewer” printer as the client's default printer when printing from Windows applications.
--links 				Defines the assigned applications for an object.
--editprofile 			Whether users can create and edit profiles for use with the Native Client.
--clipboard 			Whether users can use copy and paste in Windows or X application sessions.
--serialport 			Whether users can access the serial ports on a client device from a Windows application.
--file 					Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new OU object with the name IT, belonging to the organization object Example, which must already exist.
This OU inherits assigned applications from its parent, the organization object.
Connections for all users in the OU are secure (SSL-based) unless their user profile objects are configured to give a different type of connection.

CODE

visulox-portal object new_orgunit --name "o=Example/ou=IT" --inherit true --conntype '*:*:SSL'

The following example creates three OU objects using a batch script defined as a “here-document”.
The OU Administration belongs to the OU Finance, just created. You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_orgunit --file - <<EOF
--name "o=Example/ou=IT"
--name "o=Example/ou=Finance"
--name "o=Example/ou=Finance/ou=Administration"
EOF

visulox-portal object new_person

Creates one or more user profile objects.

Syntax

CODE

visulox-portal object new_person {
--name obj
--surname surname
[ --description text ]
[ --user user ]
[ --email name@domain ]
[ --ntdomain dom ]
[ --inherit true|false ]
[ --shared true|false ]
[ --enabled true|false ]
[ --conntype type_spec... ]
[ --cdm drive_spec... ]
[ --keymap keymap ]
[ --bandwidth limit ]
[ --links obj... ]
[ --userprintingconfig 1|0 ]
[ --mapprinters 2|1|0 ]
[ --pdfenabled 1|0 ]
[ --pdfviewerenabled 1|0 ]
[ --pdfdriver driver_name ]
[ --pdfisdefault 1|0 ]
[ --pdfviewerisdefault 1|0 ]
[ --editprofile 2|1|0 ]
[ --clipboard 2|1|0 ]
[ --serialport 2|1|0 ]
} | --file file

Description

Available options for this command.

CODE

--name 					The common name of the object in the VISULOX Portal datastore.
--surname 				The surname, or family name, for the user profile.
--description 			A text description of the object.
--user 					The user name for the user profile. This is typically their UNIX system user name.
--email 				The email address for the user profile.
--ntdomain 				The Windows domain used for application server authentication.
--inherit 				Whether the assigned applications for the object also includes the assigned applications for the object's parent.
--shared 				Whether the user profile object is used by a single user, or can be shared by multiple users in the form of a “guest” account.
--enabled 				Whether someone can log in using this user profile object.
--conntype 				Defines the connections that are allowed between the client device and the VISULOX Portal server.
--bandwidth 			The maximum bandwidth this person can use for applications.
--links 				Defines the assigned applications for an object.
--userprintingconfig 	Enables user-specific printing configuration.
--mapprinters 			The client printers users can print to when printing from Windows applications.
--pdfenabled 			Enables users to print using the VISULOX Portal “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled 		Enables users to print using the VISULOX Portal “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver 			The printer driver to use for VISULOX Portal PDF printing when printing from Windows applications.
--pdfisdefault 			Sets the VISULOX Portal “Universal PDF Printer” printer as the client's default printer when printing from Windows applications.
--pdfviewerisdefault 	Sets the VISULOX Portal “Universal PDF Viewer” printer as the client's default printer when printing from Windows applications.
--editprofile 			Whether users can create and edit profiles for use with the VISULOX Portal Client.
--clipboard 			Whether users can use copy and paste in X or Windows application sessions.
--serialport 			Whether users can access the serial ports on a client device from a Windows application.
--file 					Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new user profile object for Indigo Jones. Indigo inherits assigned applications from the organization object.

CODE

visulox-portal object new_person --name "o=Example/cn=Indigo Jones" \
--surname Jones --user indigo --email indigo@example.com --inherit true

The following example creates three user profile objects using a batch script defined as a “here-document”.
You can alternatively store the batch script in a file, and reference it using --file filename.

CODE

visulox-portal object new_person --file - <<EOF
--name "o=Example/cn=Indigo Jones" --surname Jones
--name "o=Example/ou=IT/cn=Bill Orange" --surname Orange
--name "o=Example/ou=Finance/cn=Mulan Rouge" --surname Rouge
EOF

visulox-portal object new_windowsapp

Creates one or more Windows application objects.

Syntax

CODE

visulox-portal object new_windowsapp {
--name obj
--width pixels
--height pixels
[ --description text ]
[ --winproto wts|none ]
[ --ntdomain dom ]
[ --app pathname ]
[ --args args ]
[ --appserv obj... ]
[ --workingdir dir ]
[ --resumable never|session|always ]
[ --displayusing independent|kiosk|seamless ]
[ --maxinstances 0|instances ]
[ --maximize true|false ]
[ --scalable true|false ]
[ --depth 8|16|24/32 ]
[ --icon icon_name ]
[ --hints hint...]
[ --compression automatic|on|off ]
[ --execution automatic|inorder|optimized ]
[ --interlaced automatic|on|off ]
[ --enhancedgraphics 1|0 ]
[ --delayed true|false ]
[ --login script ]
[ --protoargs args ]
[ --resumetimeout mins ]
[ --middlemouse ms ]
[ --dpi monitordpi ]
[ --loadbal default|cpu|memory|sessions ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
[ --clipboardlevel level ]
[ --windowclose suspendsession|endsession ]
[ --cdm drive_spec... ]
[ --appprintingconfig 1|0 ]
[ --mapprinters 2|1|0 ]
[ --pdfenabled 1|0 ]
[ --pdfviewerenabled 1|0 ]
[ --pdfdriver driver_name ]
[ --pdfisdefault 1|0 ]
[ --pdfviewerisdefault 1|0 ]
[ --allowkioskescape true|false ]
[ --swmopts true|false ]
[ --console 1|0 ]
[ --remotewindowkeys true|false ]
[ --disablewallpaper 1|0 ]
[ --disablefullwindowdrag 1|0 ]
[ --disablemenuanimations 1|0 ]
[ --disabletheming 1|0 ]
[ --disablecursorshadow 1|0 ]
[ --disablecursorsettings 1|0 ]
[ --enablefontsmoothing 1|0 ]
[ --noprintprefs 1|0 ]
[ --remoteaudio 1|0 ]
[ --enhancednetworksecurity 1|0 ]
[ --ssoauth 2|1|0 ]
} | --file file

Description

The following table shows the available options for this command.

CODE

--name 						The common name of the object in the VISULOX Portal datastore.
--width 					The width of the application, in pixels.
--height 					The height of the application, in pixels.
--description 				A text description of the object.
--winproto 					Whether to run the Windows application from an application server using Remote Desktop Protocol.
--ntdomain 					The Windows domain to use for the application server authentication process.
--app 						Full path name of the application.
--args 						The command-line arguments to use when starting the application.
--appserv 					The application servers that can run the application.
--workingdir 				Working directory to be used by the application.
--resumable 				Resumability behavior for the application.
--displayusing 				How the application is displayed to the user.
--maxinstances 				The maximum number of instances of the application a user can run simultaneously.
--maximize 					The initial size of the application.
--scalable 					Scale the application to fit the window in which it is displayed.
--depth 					Color depth for the application.
--icon 						Workspace icon for the application.
--hints 					String containing additional namevalue data for the application.
--compression 				Whether the AIP protocol compresses commands for transmission.
--execution 				Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.
--interlaced 				Enables interlaced image transmission.
--enhancedgraphics 			Enables enhanced graphics for the application's display.
--delayed 					Enables delayed updates of the application's display.
--login 					The login script used to start the application.
--protoargs 				Command-line arguments used for the VISULOX Portal Remote Desktop Client.
--resumetimeout 			Number of minutes the application is resumable for.
--middlemouse 				Timeout for emulating a middle mouse button click using a twobutton mouse.
--dpi 						Monitor resolution that VISULOX Portal reports to X applications.
--loadbal 					Load balancing algorithm to use.
--ldapusers 				Assigns the application to the specified LDAP users.
--ldapgroups 				Assigns the application to the specified LDAP groups.
--ldapsearch 				Assigns the application to the users that match the LDAP search criteria.
--clipboardlevel 			Clipboard security level for the application.
--windowclose 				Effect on application session of closing the main application window.
--appprintingconfig 		Enables application-specific printing configuration.
--mapprinters 				The client printers users can print to when printing from the application.
--pdfenabled 				Enables users to print using the VISULOX Portal “Universal PDF Printer” printer when printing from the application.
--pdfviewerenabled 			Enables users to print using the VISULOX Portal “Universal PDF Viewer” printer when printing from the application.
--pdfdriver 				The printer driver to use for VISULOX Portal PDF printing when printing from the application.
--pdfisdefault 				Sets the VISULOX Portal “Universal PDF Printer” printer as the client's default printer when printing from the application.
--pdfviewerisdefault 		Sets the VISULOX Portal “Universal PDF Viewer” printer as the client's default printer when printing from the application.
--allowkioskescape 			Enables a pull-down header for kiosk mode applications.
--swmopts 					Enables local window hierarchy for applications displayed in seamless windows mode. Needed for compatibility with some Borland applications.
--console 					Starts the application in console mode, also called remote administration mode.
--remotewindowkeys 			Sends window management key strokes to the remote session.
--disablewallpaper 			Disables background wallpaper. This can improve performance.
--disablefullwindowdrag 	Disables the option to show the contents of a window when it is moved. This can improve performance.
--disablemenuanimations 	Disables transition effects for menus and tooltips. This can improve performance.
--disabletheming 			Disables themes for the application. This can improve performance.
--disablecursorshadow 		Disables the mouse pointer shadow. This can improve performance.
--disablecursorsettings 	Disables mouse pointer schemes and customizations. This can improve performance.
--enablefontsmoothing 		Enables font smoothing for text in the application. This can improve text readability, but can affect performance.
--noprintprefs 				Disables caching of printer preferences, such as paper size and page orientation.
--remoteaudio 				Leaves audio at the remote application server.
--enhancednetworksecurity 	Uses enhanced security, such as Transport Layer Security (TLS) or Network Level Authentication (NLA) using CredSSP.
--ssoauth 					Uses single sign-on authentication for the application.
--file 						Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new Windows application object for the application Write-o-Win. The application runs on the application server rome.

CODE

visulox-portal object new_windowsapp --name "o=applications/cn=Write-o-Win" \
--width 1000 --height 800 --app c:\\programs\\apps\\write.exe \
--appserv "o=appservers/ou=Sales/cn=rome"

visulox-portal object new_xapp

Creates one or more X application objects.

Syntax

CODE

visulox-portal object new_xapp {
--name obj
--width pixels
--height pixels
[ --description text ]
[ --app pathname ]
[ --args args ]
[ --appserv obj... ]
[ --method telnet|ssh ]
[ --resumable never|session|always ]
[ --endswhen lastclient|windowmanager|windowmanageralone|nowindows|loginscript|loginscriptnowindows ]
[ --maxinstances 0|instances ]
[ --displayusing clientwm|independent|kiosk ]
[ --variablerootsize true|false ]
[ --maximize true|false ]
[ --scalable true|false ]
[ --depth 8|16|24|16/8|24/8|8/16|8/24 ]
[ --icon icon_name ]
[ --hints hint...]
[ --clipboardlevel level ]
[ --roottype default|custom ]
[ --rootcolor color ]
[ --compression automatic|on|off ]
[ --execution automatic|inorder|optimized ]
[ --quality automatic|best|24|21|18|16|15|12|9|6 ]
[ --interlaced automatic|on|off ]
[ --enhancedgraphics 1|0 ]
[ --delayed true|false ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
[ --loadbal default|cpu|memory|sessions ]
[ --env setting... ]
[ --login script ]
[ --winmgr command... ]
[ --resumetimeout mins ]
[ --middlemouse ms ]
[ --force3button true|false ]
[ --windowclose notifyapp|killapp|suspendsession|endsession ]
[ --dpi monitordpi ]
[ --keepopen true|false ]
[ --share true|false ]
[ --securityextension true|false ]
[ --ssharguments args ]
[ --unixaudiopreload true|false ]
[ --remotewindowkeys true|false ]
[ --allowkioskescape true|false ]
[ --allowsshdowngrade true|false ]
[ --ssoauth 2|1|0 ]
} | --file file

Description

Available options for this command.

CODE

--name 					The common name of the object in the VISULOX Portal datastore.
--width 				The width of the application, in pixels.
--height 				The height of the application, in pixels.
--description 			A text description of the object.
--app 					Full path name of the application.
--args 					The command-line arguments to use when starting the application.
--appserv 				The application servers that can run the application.
--method 				The mechanism used by the VISULOX Portal server to access the application server and start the application.
--resumable 			Resumability behavior for the application.
--endswhen 				When the application session ends.
--maxinstances 			The maximum number of instances of the application a user can run simultaneously.
--displayusing 			How the application is displayed to the user.
--variablerootsize 		Resize the root window to match the size of the user's screen.
--maximize 				The initial size of the application.
--scalable 				Scale the application to fit the window in which it is displayed.
--depth 				Color depth for the application
--icon 					Workspace icon for the application.
--hints 				String containing additional name-value data for the application.
--clipboardlevel 		Clipboard security level for the application.
--roottype 				Appearance of the root window.
--rootcolor 			Color of the root window
--compression 			Whether the AIP protocol compresses commands for transmission.
--execution 			Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.
--quality 				The effective color depth displayed on client devices.
--interlaced 			Enables interlaced image transmission.
--enhancedgraphics 		Enables enhanced graphics for the application's display.
--delayed 				Enables delayed updates of the application's display.
--ldapusers 			Assigns the application to the specified LDAP users.
--ldapgroups 			Assigns the application to the specified LDAP groups.
--ldapsearch 			Assigns the application to the users that match the LDAP search criteria.
--loadbal 				Load balancing algorithm to use.
--env 					Environment variable settings needed to run the application.
--login 				The login script used to start the application.
--winmgr 				The Window Manager to use for the application.
--resumetimeout 		Number of minutes the application is resumable for.
--middlemouse 			Timeout for emulating a middle mouse button click using a two-button mouse.
--force3button 			Specifies that the application only supports a 3-button mouse.
--windowclose 			Effect on application session of closing the main application window.
--dpi 					Monitor resolution that VISULOX Portal reports to X applications.
--keepopen 				Keep open the connection used to start the application.
--share 				Enables resource sharing for similar application sessions.
--securityextension 	Enables the X Security Extension for the application.
--ssharguments 			Command-line arguments for the ssh client.
--unixaudiopreload 		Enables the VISULOX Portal audio redirection library.
--remotewindowkeys 		Sends window management key strokes to the remote session.
--allowkioskescape 		Enables a pull-down header for kiosk mode applications.
--allowsshdowngrade 	Enables VISULOX Portal to try an X11 connection instead of SSH, when X11 forwarding is not configured or working.
--ssoauth 				Uses single sign-on authentication for the application.
--file 					Batch file used to create multiple objects within the organizational hierarchy.

To batch-create multiple objects, use the --file option. Use the other options to create a single object.

Examples

The following example creates a new X application object for the application XFinance. The application can be run on the application servers paris, bonn, or lisbon. Application server load balancing decides which one to use.

CODE

visulox-portal object new_xapp --name "o=applications/ou=Finance/cn=XFinance" \
--width 1000 --height 800 --app /usr/local/bin/xfinance \
--appserv "o=appservers/ou=Finance/cn=paris" \
"o=appservers/ou=Finance/cn=bonn" "o=appservers/cn=lisbon"

visulox-portal object remove_host

Removes application servers from the list of those that can run an application, for application server load balancing.

Syntax

CODE

visulox-portal object remove_host { --name obj... --host hobj...} | --file file

Description

Available options for this command.

CODE

--name 		Specifies the names of application objects you want to configure load balancing for.
--host 		Specifies the names of application server objects you want to remove from the load balancing pool.
--file 		Specifies a file containing a batch of commands to configure application server load balancing.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example removes the application server rome from the load balancing pool for the application Slide-o-Win.

CODE

visulox-portal object remove_host --name "o=applications/cn=Slide-o-Win" \
--host "o=appservers/ou=Sales/cn=rome"

The following example removes the group WinHosts from the load balancing pool for the applications Write-o-Win and Slide-o-Win.
Load balancing is no longer performed across all the application servers in WinHosts.

CODE

visulox-portal object remove_host --name "o=applications/cn=Write-o-Win" \
"o=applications/cn=Slide-o-Win" --host "o=appservers/cn=WinHosts"

visulox-portal object remove_link

Removes assigned applications links for an object.

Syntax

CODE

visulox-portal object remove_link { --name obj... --link lobj...} | --file file

Description

Available options for this command.

CODE

--name		Specifies the names of objects you want to remove links for.
--link 		Specifies the names of objects you want to remove links for.
--file 		Specifies a file containing a batch of commands to remove links for.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example removes the Write-o-Win application from the assigned applications for Violet Carson.

CODE

visulox-portal object remove_link --name "o=Example/ou=Sales/cn=Violet Carson" --link "o=applications/cn=Write-o-Win"

The following example removes the group Applications from the assigned applications of the organizational units Sales and Marketing.
Everyone who inherits assigned applications from one of these OUs no longer sees all the applications in their assigned applications.
For example, if they belong to that OU and is selected for their user profile object. However, they may still see an application if it is inherited from elsewhere.

CODE

visulox-portal object remove_link --name "o=Example/ou=Sales" \
"o=Example/ou=Marketing" --link "o=applications/cn=Applications"

visulox-portal object remove_mapping

Removes type-application mappings for a dynamic application object.

Syntax

CODE

visulox-portal object remove_mapping {--name obj --mappingtype [type]} | --file file

Description

Available options for this command.

CODE

--name 			The name of the dynamic application object.
--mappingtype 	Type of mapping to be removed.
--file 			A file containing a batch of commands to remove mappings.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example removes a mapping for the windows type from a dynamic application object with common name winApp.

CODE

visulox-portal object remove_mapping --name "o=applications/cn=winApp" --mappingtype windows

The following example removes a mapping for the solaris type from a dynamic application object named desktopApp.

CODE

visulox-portal object remove_mapping --name "o=applications/cn=desktopApp" --mappingtype solaris

visulox-portal object remove_member

Removes objects from groups.

Syntax

CODE

visulox-portal object remove_member { --name obj... --member mobj...} | --file file

Description

Available options for this command.

CODE

--name 		Specifies the names of group objects you want to remove members from.
--member 	Specifies the names of objects you want to remove from the groups.
--file 		Specifies a file containing a batch of commands to remove group members.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example removes the Write-o-Win application from the group Applications.

CODE

visulox-portal object remove_member --name "o=applications/cn=Applications" --member "o=applications/cn=Write-o-Win"

The following example removes the three application server objects rome, brussels, and berlin from the group WinHosts.

CODE

visulox-portal object remove_member --name "o=appservers/cn=WinHosts" \
--member "o=appservers/ou=Sales/cn=rome" "o=appservers/cn=brussels" \
"o=appservers/ou=Marketing/cn=berlin"

visulox-portal object rename

Renames or moves an object in the organizational hierarchy.

Syntax

CODE

visulox-portal object rename { --name obj... --newname newobj...} | --file file

Description

The following table shows the available options for this command.

CODE

--name 		Specifies the name of the object you want to rename or move.
--newname 	Specifies the new name of the object.
--file 		Specifies a file containing a batch of commands to rename or move objects.

Make sure you quote any object names containing spaces, for example, "o=Example Organization".

Examples

The following example renames the user profile object for Elizabeth Blue to Liz Blue.

CODE

visulox-portal object rename --name "o=Example/ou=Sales/cn=Elizabeth Blue" \
--newname "o=Example/ou=Sales/cn=Liz Blue"

The following example moves Ginger Butcher between the organizational units IT and Sales.

CODE

visulox-portal object rename --name "o=Example/ou=IT/cn=Ginger Butcher" \
--newname "o=Example/ou=Sales/cn=Ginger Butcher"

visulox-portal object script

Runs a batch script of visulox-portal object commands, or enables commands to be run interactively.

Syntax

CODE

visulox-portal object script

Description

The batch script consists of standard visulox-portal object commands, one per line, without the visulox-portal object prefix. For example, use edit rather than visulox-portal object edit.
The batch script can use a back slash (\) to break commands across multiple lines. Lines beginning with a hash (#) are treated as comments and ignored.

If you need to include quotes (") or a backslash (\) character in any of the values for the commands, you must backslash protect them. For example, to use "c:\\Program Files" as a value for the --args option, type the following: --args "\"c:\\Program Files\""

The command reads from standard input. For example, you can use a “here-document” to run a batch script:

CODE

visulox-portal object script <<EOF
commands
EOF

If standard input is empty, you can run visulox-portal object commands interactively.

Examples

The following example adds the group Applications to the organizational units Sales and Marketing, and sets the Sales OU's attribute to false.

CODE

visulox-portal object script <<EOF
add_link
--name "o=Example/ou=Sales"
"o=Example/ou=Marketing"
--link "o=Example/cn=Applications"
edit
--name "o=Example/ou=Sales" --inherit false
EOF