Get-LXCADeployGlobalSetting

This cmdlet retrieves the global settings that are used to deploy operating systems, such as IP assignment type (static or DHCP), storage location, and deployment credentials.

Note: You cannot pipe objects to this cmdlet.

Syntax

Get-LXCADeployGlobalSetting [-Connection LXCAConnection]
                            [CommonParameter]

Parameters

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results

This cmdlet returns a DeployGlobalSetting object, for example:

   public class DeployGlobalSetting
   {
      public CredentialSetting[] Credentials;
      public string IpAssignment;     //staticv4|staticv6|dhcpv4
      public ActiveDirectorySetting ActiveDirectory;
      public LicenseKeySetting LicenseKeys;

      public class CredentialSetting
      {
         public string Type;      //"ESXi", "LINUX", or "WINDOWS", readonly
                              //"RHEL/ESXi" can also be used but will be deprecated in a future 
                              //release.
         public string Name;      //"root" or "Administrator", readonly
         public string Password;   //Empty string
      }

      public class ActiveDirectorySetting
      {
         public DomainSetting[] AllDomains;
         public string DefaultDomain;

         public class DomainSetting
         {
            public int ID;
            public string DomainName;
            public string OU;
         }
      }

      public class LicenseKeySetting
      {
         public Win2022R1Key Win2022R1;
         public Win2019R1Key Win2019R1;
         public Win2016R1Key Win2016R1;
         public Windows10Key Windows10;
         public Windows11Key Windows11;

         public class Win2016R1Key
         {
            public string StandardLicenseKey;
            public string DataCenterLicenseKey;
         }
          public class Win2019R1Key
         {
            public string StandardLicenseKey;
            public string DataCenterLicenseKey;
         }
         public class Win2022R1Key
         {
            public string StandardLicenseKey;
            public string DataCenterLicenseKey;
         }
         public class Windows10Key
         {
            public string EnterpriseLicenseKey;
            public string WorkstationLicenseKey;
         }
         public class Windows11Key
         {
            public string EnterpriseLicenseKey;
            public string WorkstationLicenseKey;
         }
      }
   }

Examples

The following example retrieves the global settings that are used for operating-system deployment.

$cred = Get-Credential
Connect-LXCA -Host 192.0.2.0 -Credential $cred

$setting = Get-LXCADeployGlobalSetting

Disconnect-LXCA

Related links