Developer Documentation
Citrix Daas SDK

about_Hyp_CustomProperties

November 26, 2024
Contributed by: 
C C

Topic

XenServer SDK - Custom Properties

Short Description

Overview of custom properties settings for a HypervisorConnection object.

Long Description

Custom properties are properties of the HypervisorConnection object, which are specific to the object’s hosting hypervisor infrastructure. Custom properties can be used to control or tune behaviors of the hosting connection.

Custom Properties For Azure Resource Manager

The following custom properties are specific to AzureRM.

  • SubscriptionId: (String) The Azure Subscription ID.

  • TenantId: (String) The Azure Tenant ID.

  • AuthenticationAuthority: (String) The Microsoft user authentication endpoint. e.g. “https://login.microsoftonline.com/”

  • ManagementEndpoint: (String) The Azure Resource Manager endpoint used to establish communications with Azure APIs. e.g. “https://management.azure.com/”

  • StorageSuffix: (String) The DNS suffix of the Azure Storage endpoint URL. There are 4 default suffix strings, each one belonging to a different Azure environment: Azure Global: “core.windows.net” Azure China: “core.chinacloudapi.cn” Azure US Government: “core.usgovcloudapi.net” Azure Germany: “core.cloudapi.de”

  • ResourceManagementOperationPollingInterval: (Int) How long Azure waits before polling the status of all running operations managed by Azure’s ResourceManagementClient class. Default is 3 seconds in order to poll often without throttling Azure by polling more often than necessary.

  • MaximumConcurrentProvisioningOperations: (Int) The number of threads to use within the hypervisor manager, which limits number of simultaneous MCS Operations that are permitted in the provisioning workflow. Default is 500 threads for Azure, where each thread manages exactly one MCS Operation. Increasing the number of threads is not recommended.

  • PowerStateCacheExpirationInMinutes: (Int) The number of minutes until the memory cache, where the power state is stored, is expired. Once expired, one Azure API call will be made to get the latest power status for all Azure related catalogs in the site. This effectively refreshes the memory cache. Default is 5 mins.

  • PowerStateCacheDegreeOfParallelism: (Int) The number of threads that should be used to fetch missing power states, individually, in parallel, in the event where some machines may be missing from an Azure Resource Graph (ARG) response. In such cases, power states for machines are fetched individually, either through another ARG query or a Virtual Machine ‘Get’ call. Default number of threads is 10. The number of threads provided as an argument must be between 1 and 512.

  • PowerStateCacheUseCachedValuesOnlyAfterInSeconds: (Int) The number of seconds that can elapse before individual ‘Get’ state calls to Azure are no longer queried and instead machine power states are returned from the memory cached.

    Querying machine power states follows a three step process:

    1. A single Azure Resource Graph (ARG) call is used to query all machine

    power states.

    1. Machine power states that were not picked up by ARG are subsequently

    individually queried by Azure ‘Get’ state calls.

    1. Machine power states not successfully queried by Azure ‘Get’ state

    calls within this custom property’s timeframe will be returned from the memory cache.

    If a machine’s power state is not found in the memory cache, then it will be reported as Unknown. Default is 180 seconds. This property does not check if any query has timed out.

  • AuthenticationMode: (String) Specify the authentication method for interacting with Azure services. It can be set to one of three values: AppClientSecret, SystemAssignedManagedIdentity, and UserAssignedManagedIdentity.

    1. AppClientSecret: used for authentication scenarios involving an application

    ID and a client secret. Fill in application ID as UserName and client secret as SecurePassword of the hosting connection.

    1. SystemAssignedManagedIdentity: refers to the use of Azure’s system-assigned

    managed identities, which are automatically managed by Azure and tied to a specific Azure service instance, providing a seamless and secure authentication method without the need for credentials in code. Fill in “system-assigned” as the UserName and SecurePassword of the hosting connection.

    1. UserAssignedManagedIdentity: allows for the use of Azure’s user-assigned

    managed identities, offering more flexibility by allowing a single identity to be used across multiple Azure services. Fill in the client id of the user-assigned managed identity as UserName and “user-assigned” as the SecurePassword of the hosting connection.

Custom Properties For Aws

The following custom properties are specific to the HypervisorConnection object using the AWS plugin.

  • MaximumConcurrentProvisioningOperations: (Int) The number of threads to use within the hypervisor manager, which limits number of simultaneous MCS Operations that are permitted in the provisioning workflow. Default is 100 threads for AWS, where each thread manages exactly one MCS Operation. Increasing the number of threads is not recommended.

Custom Properties For Gcp

The following custom properties are specific to the HypervisorConnection object using the GCP plugin.

  • MaximumConcurrentProvisioningOperations: (Int) The number of threads to use within the hypervisor manager, which limits number of simultaneous MCS Operations that are permitted in the provisioning workflow. Default is 500 threads for GCP, where each thread manages exactly one MCS Operation. Increasing the number of threads is not recommended.

See Also

about_Hyp_CustomProperties
November 26, 2024
Contributed by: 
C C
November 26, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.