Anyware Manager Configures Connector
When installing the Connector you are required to provide several command line parameters. This is a requirement for every Connector you want to install in a deployment. To avoid this redundant activity and enhance user experience, Anyware Manager allows you to save the Connector configuration and use them as-is for configuring another Connector. This functionality is termed as Anyware Manager Configures Connector. After configuring the first Connector in your deployment, the configuration details are saved and re-used if necessary for future Connector installations.
The Anyware Manager Configures Connector is a critical feature in the HP Anyware Manager software and the minimum supported versions for this feature are Anyware Manager 22.09 and the Connector v136. If a version of the Anyware Manager is not able to support this feature functionality, it throws a warning message during installation as an indication that pulling the Connector settings and pushing them into a new Connector is not supported. This feature is currently supported in the Beta mode of the Admin Console. Features in this mode are still being worked on and refined by HP.
How to use Anyware Manager Configures Connector?¶
When the first Connector is configured, you need to save and push these settings for future use in the Anyware Manager. These saved settings are pulled later when configuring another instance of the Connector.
To save or push the Connector settings into the Anyware Manager use the following flag along with the install or update command:
To retrieve or pull the Connector settings from the Anyware Manager use the following flag along with the install or update command:
What Information is Stored in the Anyware Manager?¶
Anyware Manager stores the Connector configuration information on two levels. Deployment level and Connector level.
Information Stored in the Anyware Manager on Deployment Level¶
|Computer's Domain Name||The base Domain Name to search for computers within the Active Directory. Specify multiple Domain Names with multiple options.|
|Computers Filter||The filter to search for computers within the Active Directory. Specify multiple filters with multiple options. Default computer filter (&(primaryGroupID=515)(objectCategory=computer))|
|User's Domain Name||The base Domain Name to search for users within the Active Directory. Specify multiple Domain Names with multiple options.|
|Users Filter||The filter to search for users within the Active Directory. Specify multiple filters with multiple options. Default user filter (&(objectCategory=person)(objectClass=user))|
|Domain Name||The Active Directory domain that remote workstations should be joined to.|
|IDAP CA Certificates||PEM formatted file containing any custom Certificate Authority's public certificate to be used for verifying LDAPs connections to Active Directory. An empty string will clear the setting.|
|Pools Group||The Domain Name for the Active Directory domain group that manages users and remote workstations in the Management interface.|
|Sync Interval||The interval (in minutes) for how often to sync the Active Directory users and computers with Anyware Manager Service.|
When this information is saved for the first Connector in the deployment it can be re-used by any new connector in the same deployment.
Information Stored in the Anyware Manager on Connector Level¶
|Connector Network CIDR||The CIDR to use for the Connector's docker network.|
|Domain Controllers||Domain controller FQDN to use. May be specified multiple times for more than one DC.|
|External Client CIDR||The CIDR for PCoIP Clients that connect to workstations through the Security Gateway.|
|Internal Client CIDR||The CIDR for PCoIP Clients that connect to workstations directly.|
|Https Proxy||URL for an HTTPS proxy (overrides related proxy settings in environment variables).|
|IP||Sets the IPv4 address for the Connector for external connections.|
|License Server URL||URL for HP PCoIP License Server to be used for PCoIP Sessions. If this is not provided, ensure that the Cloud License Server is registered on the PCoIP Agent.|
|MFA Enable||Enable MFA/2FA.|
|MFA Server||The FQDN or IP address of the RADIUS server to use for MFA.|
|Preferred Name||A Setting used to determine if a hostname or machine name should be displayed to identify the workstations.|
|Retrieve Agent State||Enable/disable retrieving PCoIP agent state.|
|Show Agent State||Show/hide PCoIP agent state (showing requires retrieve-agent-state to be true).|
|Service Account Username||The username for the AD account with permission to join machines to the domain.|
|Ingress TLS Certificate||Ingress TLS Certificate.|
|Self Signed||Automatically generate self-signed SSL cert and key for testing purposes.|
These settings can be used only by the Connector.
Creating a New Connector Using the Saved Configuration from another Connector¶
When setting up a new Connector, the user can use the clone feature to copy the setting from one Connector to another connector.
The procedure is as follows:
- Log in to the Admin Console, and enable the Beta UI toggle.
- Navigate to the Connectors tab and click "+" icon to create a new Connector.
- Provide the new Connector name and select the Connector you wish to copy settings from in the Copy connector configuration from dropdown list.
- Click Generate to generate a Connector token.
- Install the Connector with the token and include the
--pull-connector-configflag in the install command.
The new Connector is configured with the settings from the another Connector.