net45/VMware.VimAutomation.License.Commands.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-LicenseDataManager</command:name>
      <command:verb>Get</command:verb>
      <command:noun>LicenseDataManager</command:noun>
      <maml:description>
        <maml:para>Returns the vSphere LicenseDataManager objects for the specified vSphere servers.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Returns the vSphere LicenseDataManager objects for the specified vSphere servers.</maml:para>
      <maml:para>The LicenseDataManager object allows programmatic access to the vSphere licensing functionality and can be used to associate license data with vCenter Server inventory nodes. The license data consists of VMware licensing material and takes the form of a list of {license type id, license key} pairs. The inventory nodes which can be associated with license data are individual hosts or host containers, such as clusters, datacenters and datacenter folders. Presence of such license data makes it possible to support automatic licensing when hosts are added to a particular host container entity.</maml:para>
      <maml:para>LicenseDataManager provides methods for retrieving, creating, modifying and removing associations between license data and inventory nodes.</maml:para>
      <maml:para>For more information about LicenseDataManager type: Get-Help about_licensedatamanager</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-LicenseDataManager</maml:name>
        <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none">
          <maml:name>Server</maml:name>
          <maml:Description>
            <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue>
          <dev:type>
            <maml:name>VIServer[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none">
        <maml:name>Server</maml:name>
        <maml:Description>
          <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue>
        <dev:type>
          <maml:name>VIServer[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>LicenseDataManager</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Get-LicenseDataManager is supported only on servers that are vCenter Server 5.0 or later.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager
 
$licenseDataManager.QueryEntityLicenseData()</dev:code>
        <dev:remarks>
          <maml:para>Retrieves all entity&lt;-&gt;license data associations.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>$viServer = Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager -Server $viServer
 
$hostContainer = Get-Datacenter -Name Datacenter1
 
$licenseDataManager.QueryAssociatedLicenseData($hostContainer.Uid)</dev:code>
        <dev:remarks>
          <maml:para>Retrieves the license data associated with Datacenter1.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>$viServer = Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager -Server $viServer
 
$licenseData = New-Object Vmware.VimAutomation.License.Types.LicenseData
 
$licenseKeyEntry = New-Object Vmware.VimAutomation.License.Types.LicenseKeyEntry
 
$licenseKeyEntry.TypeId = "vmware-vsphere"
 
$licenseKeyEntry.LicenseKey = "00000-11111-11111-11111-11111"
 
$licenseData.LicenseKeys += $licenseKeyEntry
 
$hostContainer = Get-Datacenter -Name Datacenter1
 
$licenseDataManager.UpdateAssociatedLicenseData($hostContainer.Uid, $licenseData)</dev:code>
        <dev:remarks>
          <maml:para>Associates new license data with Datacenter1. The license data holds single license key entry suitable for licensing vSphere hosts.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
        <dev:code>$viServer = Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager -Server $viServer
 
$hostContainer = Get-Datacenter -Name Datacenter1
 
$licenseDataManager.UpdateAssociatedLicenseData($hostContainer.Uid, $null)</dev:code>
        <dev:remarks>
          <maml:para>Removes the license data (if any) associated with Datacenter1.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 5 --------------------------</maml:title>
        <dev:code>$viServer = Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager -Server $viServer
 
$hostContainer = Get-Datacenter -Name Datacenter1
 
$licenseDataManager.QueryEffectiveLicenseData($hostContainer.Uid)</dev:code>
        <dev:remarks>
          <maml:para>Retrieves the merged license data associated with Datacaneter1 and its host container predecessors (in the context of the inventory) (if such predecessors exist and if they are associated some license data). The data is merged in bottom-up fashion such that there is only one license key entry per type id (e.g. child license key entry for a license type id is with higher priority). The resulting merged license data is the effective data used for automatic licensing when vSphere host is added to Datacenter1.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 6 --------------------------</maml:title>
        <dev:code>$viServer = Connect-VIServer -Server 10.23.112.235
 
$licenseDataManager = Get-LicenseDataManager -Server $viServer
 
$host = Get-VMHost -Name Host1
 
$licenseDataManager.ApplyAssociatedLicenseData($host.Uid)</dev:code>
        <dev:remarks>
          <maml:para>Applies the merged license data associated with Host1 and its host container predecessors (using the same rules as in QueryEffectiveLicenseData($host.Uid)) to Host1.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-LicenseDataManager.html</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-LicensingCommand</command:name>
      <command:verb>Get</command:verb>
      <command:noun>LicensingCommand</command:noun>
      <maml:description>
        <maml:para>This function retrieves all commands of the VMware.VimAutomation.License module.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This function retrieves all commands of the VMware.VimAutomation.License module, including cmdlets, aliases, and functions.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-LicensingCommand</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Name</maml:name>
          <maml:Description>
            <maml:para>Specifies the name of the command you want to retrieve.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>*</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>Name</maml:name>
        <maml:Description>
          <maml:para>Specifies the name of the command you want to retrieve.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>*</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>
        <dev:remarks>
          <maml:para>{{ Add example description here }}</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>