View API


Data Object - GlobalSettingsGeneralData

Class
VMware.Hv.GeneralData
Property of
GlobalSettingsInfo
Since
Horizon View 6.0

Data Object Description

General global settings determine session time-out lengths, status updates in View Administrator, and whether prelogin and warning messages are displayed.

Data Object Properties

Properties

Name Type Description
clientMaxSessionTimePolicyxsd:string

Client max session lifetime policy.
  • This property has a default value of "TIMEOUT_AFTER".
  • This property will be one of:
    Value Description
    "TIMEOUT_AFTER"Indicates that the client session times out after a configurable session length (in minutes)
    "NEVER"Indicates no absolute client session length (sessions only end due to inactivity
clientMaxSessionTimeMinutesxsd:int

Determines how long a user can keep a session open after logging in to View Connection Server. The value is set in minutes. When a session times out, the session is terminated and the View client is disconnected from the resource.
  • This property has a default value of 600.
  • This property need not be set.
  • This property has a minimum value of 5.
  • This property is required if clientMaxSessionTimePolicy is set to "TIMEOUT_AFTER".
clientIdleSessionTimeoutPolicyxsd:string

Specifies the policy for the maximum time that a that a user can be idle before the broker takes measure to protect the session.
  • This property has a default value of "NEVER".
  • This property will be one of:
    Value Description
    "NEVER"Indicates that the client session is never locked.
    "TIMEOUT_AFTER"Indicates that the user session can be idle for a configurable max time (in minutes) before the broker takes measure to protect the session.
clientIdleSessionTimeoutMinutesxsd:int

Determines how long a that a user can be idle before the broker takes measure to protect the session. The value is set in minutes.
  • This property has a default value of 15.
  • This property need not be set.
  • This property is required if clientIdleSessionTimeoutPolicy is set to "TIMEOUT_AFTER".
clientSessionTimeoutMinutesxsd:int

Determines the maximum length of time that a Broker session will be kept active if there is no traffic between a client and the Broker. The value is set in minutes.
  • This property has a default value of 1200.
  • This property has a minimum value of 5.
desktopSSOTimeoutPolicyxsd:string

The single sign on setting for when a user connects to View Connection Server.
  • This property will be one of:
    Value Description
    "DISABLE_AFTER"SSO is disabled the specified number of minutes after a user connects to View Connection Server.
    "DISABLED"Single sign on is always disabled.
    "ALWAYS_ENABLED"Single sign on is always enabled.
desktopSSOTimeoutMinutesxsd:int

SSO is disabled the specified number of minutes after a user connects to View Connection Server.
  • This property need not be set.
  • This property has a minimum value of 1.
  • This property is required if desktopSSOTimeoutPolicy is set to "DISABLE_AFTER".
applicationSSOTimeoutPolicyxsd:string

The single sign on timeout policy for application sessions.
  • This property has a default value of "ALWAYS_ENABLED".
  • This property will be one of:
    Value Description
    "DISABLE_AFTER"SSO is disabled the specified number of minutes after a user connects to View Connection Server.
    "DISABLED"Single sign on is always disabled.
    "ALWAYS_ENABLED"Single sign on is always enabled.
applicationSSOTimeoutMinutesxsd:int

The time allowed (in minutes) to elapse after a user has authenticated before the application SSO credentials are locked unless the user's client supports idle sessions and the user remains active.
  • This property need not be set.
  • This property has a minimum value of 1.
  • This property is required if applicationSSOTimeoutPolicy is set to "DISABLE_AFTER".
viewAPISessionTimeoutMinutesxsd:int

Determines how long (in minutes) an idle View API session continues before the session times out. Setting the View API session timeout to a high number of minutes increases the risk of unauthorized use of View API. Use caution when you allow an idle session to persist a long time.
  • This property has a default value of 10.
  • This property has a minimum value of 1.
  • This property has a maximum value of 4320.
preLoginMessagexsd:string

Displays a disclaimer or another message to View Client users when they log in. No message will be displayed if this is null.
  • This property need not be set.
displayWarningBeforeForcedLogoffxsd:boolean

Displays a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.
forcedLogoffTimeoutMinutesxsd:int

The number of minutes to wait after the warning is displayed and before logging off the user.
forcedLogoffMessagexsd:string

The warning to be displayed before logging off the user.
enableServerInSingleUserModexsd:boolean

Permits certain RDSServer operating systems to be used for non-RDS Desktops.
storeCALOnBrokerxsd:boolean

Used for configuring whether or not to store the RDS Per Device CAL on Broker.

Since Horizon 7.0
  • This property has a default value of false.
storeCALOnClientxsd:boolean

Used for configuring whether or not to store the RDS Per Device CAL on client devices. This value can be true only if the storeCALOnBroker is true.

Since Horizon 7.0
  • This property has a default value of false.