Licenses

Get-XpLicensesUser

Syntax

Parameter set locations:

Get-XpLicensesUser -Locations <CFGBranch[]> [-Timeout <int>]

Parameter set configGroups:

Get-XpLicensesUser -ConfigGroups <CFGConfigGroup[]> [-Timeout <int>]

Parameter set user:

Get-XpLicensesUser -UserNames <String[]> [-Timeout <int>]

Description

Get-XpLicensesUser behaves like the search function of the XPhone Connect Server Web Administration (System settings > Licenses > User).

All parameter sets use the same search function interface. If there are name conflicts between locations and user names (if one is a substring of the other), the desired results may not be displayed.

Parameter

-Locations <CFGBranch[]>
- If this parameter is specified, the search is based on the names of the locations.
- Corresponds with -UserNames <LocationName[]>
-ConfigGroups <CFGConfiggroups[]>
- If this parameter is specified, a search is performed for the names of the configuration groups.
- “Corresponds to the parameter -UserNames <ConfigurationGroupName[]>
-UserNames
- Corresponds to the normal license user search on the XPhone Connect Server Web Administration. So here you can also search for site names, login names, etc.
- Several search terms are separated by commas.
-Timeout <int>
- Timeout in minutes.
- If a command takes too long (e.g. due to too many data records or similar), this command can be aborted with this parameter after the specified time.

Input

The input type is the type of object which can be transferred to Get-XpLicensesUser via pipelining:

CFGBranch
CFGConfigGroup

Output

The command Get-XpLicensesUser returns objects of type XPCLicenseUser:

XPCLicenseUser

Property	Supported values
XmppAddress	-
LicenseOwner	-
LicenseDepartment	-
LicenseAnalytics	-
LicenseApplink	-
LicenseFax	-
LicenseOffice	-
LicenseOfficePlusPack	-
LicenseTapi	-
LicenseVoiceMail	-

Example

Export all licenses to an Excel compatible file so that it can be evaluated or printed:
```
>Get-XpLicensesUser * | Export-Csv "C:\path\XPhoneLicenses.csv" -Delimiter ";"
```

The path (C:\path\XPhoneLicenses.csv) to the specified file must already exist, but the file itself must not yet exist. The parameter -Delimiter ; is necessary for many languages (e.g. German) so that Excel recognizes the file as a CSV file.

Display all users who have drawn a fax license:

>Get-XpLicensesUser * | Where{$_.LicenseFax -eq "1"}

Have you found a mistake on this page?

Or is something not formulated well or too vague? Then we look forward to receiving an e-mail, preferably with a suggestion for improvement, to doku@c4b.de. Thank you very much!