User
Get-XpUsers
Syntax
Get-XpUsers [[-UserNames] <String[]>] [Timeout <int>]
Description
For this the XPhone Call Controller first connects to the XPhone Connect Server and then dials the desired number. By default, only the account name and telephone number are shown.
This corresponds with the advanced search on the XPhone Connect Server Web Administration (search by user, e-mail address, phone number, fax number).
Parameter
-UserNames <String[]>
Specifies the string that is searched for on the XPhone Connect server.
Several names/email addresses/phone numbers/fax numbers are possible (separated by commas).
Enclosing quotation marks are strongly recommended because special characters often appear in the strings (e.g. spaces).
-Timeout <int>
Timeout in minutes.
Input
This command does not support input via the pipeline and is usually at the beginning of a command chain.
Output
The command Get-XpUsers
returns objects of type CFGUser
.
CFGUser |
|
Property |
Supported values |
AccountName |
String |
AllowOtherLogin |
Boolean |
AllowWindowsLogin |
Boolean |
AllowXServerLogin |
Boolean |
AuthUserLocked |
Boolean |
AuthUserUnlockDateTime |
|
CfgMailBoxAccessType |
INTEGRATED |
CfgUserDirectAccessCallNumber |
|
CfgUserDirectAccessGroupId |
Integer |
CfgUserFaxGroupId |
Integer |
CfgUserFaxNumber |
String |
CfgUserMailBoxUserGroupId |
Integer |
CfgUserMailBoxUserName |
String |
CfgUserSmsReceiverCallNumber |
String |
CfgUserSmsReceiverCallNumberGroupId |
Integer |
CfgUserSmsSenderCallNumber |
String |
CfgUserSmsSenderCallNumberGroupId |
Integer |
CfgUserVoiceMailCallGroupId |
Integer |
CfgUserVoiceMailCallNumber |
String |
City |
String |
Company |
String |
Country |
String |
Department |
String |
DesktopClientDisplayVersion |
|
String |
|
FaxNumber |
String |
FirstName |
String |
LastName |
String |
MobileClientDisplayVersion |
|
HomeOfficeNumber |
String |
HomePhoneNumber |
String |
Interlock |
|
InterlockDescr |
|
Language |
|
Languages |
|
LastLoginDate |
|
LoginSystemTypeList |
|
MobileTelephoneNumber |
String |
ModifyTimeStamp |
|
OldPrimaryLineSource |
|
Password |
|
PasswordChanged |
|
PasswordConfirm |
|
Photo |
|
Position |
String |
PostalCode |
String |
PrimaryLineSource |
Integer |
PrimaryLineSourceList |
|
RelationshipRole |
Normal |
RelationshipRoleAssistant |
Boolean |
RelationshipRoleVip |
Boolean |
RequiredPasswordComplexity |
|
RoomNumber |
String |
Salutation |
String |
Street |
String |
SystemID |
|
SystemType |
|
TelephoneNumber |
String |
TelephonyNotAvailable |
|
Title |
String |
UMSUserConfigFaxAvailable |
Boolean |
UMSUserConfigNotAvailable |
Boolean |
UMSUserConfigSmsAvailable |
Boolean |
UMSUserConfigVoiceMailAvailable |
Boolean |
UserDefined1 |
String |
UserDefined2 |
String |
UserDefined3 |
String |
UserDefined4 |
String |
VirtualLines |
|
VoicemailPin |
|
VoicemailPinChanged |
Boolean |
VoicemailPinMinLength |
String |
WindowsAccountName |
String |
XmppAddress |
String |
XmppAddressDomain |
String |
XmppAddressLocal |
String |
Description |
String |
Name |
|
ObjectGuid |
|
ParentGuid |
|
DCObjectInfo |
|
ExtensionData |
|
UtcOffset |
Example
Show all users:
>Get-XpUsers
Showing user “Anna Amberg”:
>Get-XpUsers "Anna Amberg"
Show all users from the “Sales” department:
>Get-XpUsers | Where{$_.Department -eq "Vertrieb"}
Show all users who have never used the mobile client:
>Get-XpUsers | Where{$_.MobileClientDisplayVersion -eq ""}
Show all users who are still using an old version of the desktop client:
>Get-XpUsers | Where{$_.DesktopClientDisplayVersion -ne "6.0.1"}
The version “6.0.1” mentioned in the example is to be replaced by the latest version of the system.
To see the last used version of these users at the same time:
>Get-XpUsers | Where{$_.DesktopClientDisplayVersion -ne "6.0.1"} | Select-Object -Property Firstname,Lastname,DesktopClientDisplayVersion
Set-XpUsers
Syntax
Set-XpUsers [[-Objects] <CFGUser[]>] [-Timeout <int>`]
Description
Set-XpUsers
stores the passed CFGUser objects in the XPhone Connect Server.
All changes made to the object are immediately transferred to the XPhone Connect Server without query where they are saved.
Warning
The search basis saved is no longer valid and is deleted. Please select a new search basis.
Parameter
-Objects <CFGUser[]>
Specifies the user objects to be stored on the XPhone Connect Server.
-Timeout <int>
Timeout in minutes.
Input
The input type is the type of objects that can be pipelined to Set-XpUsers
:
CFGUser
Output
The command Set-XpUsers
does not return any objects.
Example
Renaming of the “Development” department to Software Development:
>Get-XpUsers | Where{$_.Department -eq "Entwicklung"} | foreach{$_.Department = "Software Development";$_} | Set-XpUsers
Explanation of the pipeline:
The first step gets all users from the XPhone Connect Server (
Get-XpUsers
).Then the result set is filtered by the department named Development (
Where {$_.Department -eq "Development"}
).Then, for all those users that are left after filtering, the department is changed to “Software Development” (
foreach{$_.Department = "Software Development"}
).Finally, the change is transferred to the XPhone Connect server and saved (
Set-XpUsers
).
Get-XpUsersFromADGroup
Syntax
Get-XpUsersFromADGroups [[-GroupNames] <String[]>] [-Timeout <int>`]
Description
The command returns all XPhone Connect server users that match the users in the specified security groups.
This only works for users who have been imported into XPhone Connect Server via the Active Directory connector.
All users who exist in the security group but did not exist on the XPhone Connect server (and vice versa) do not appear in the result set.
Parameter
-GroupNames <String[]>
Names of the security groups to search for in Active Directory.
The case does not matter, but the full name must be specified. So if the security group in AD is correctly named securitygroup_123, it cannot be specified as “securitygroup”, but it can be specified as securitygroup_123.
-Timeout <int>
Timeout in minutes.
Input
This command does not support input via the pipeline and is usually at the beginning of a command chain.
Output
The Get-XpUsersFromADGroups
command returns a list of type CFGUser[].
Siehe Get-XpUsers.
Example
Search all users on the XPhone Connect Server that are in the AD security group Sales:
>Get-XpUsersFromADGroups „Vertrieb"
Set the client language to English for all users from the “English” security group:
>Get-XpUsersFromADGroups „Englisch" | foreach{$_.Language = ‚en‘;$_} | Set-XpUsers .. attention:: Die in diesem Beispiel gezeigte Änderung der Sprache wird nur für den Benutzer wirksam, wenn er noch nie manuell in seinem Client eine Sprache eingestellt hat. Andernfalls hat die vom Benutzer selbst eingestellte Sprache Priorität.
Have you found an mistake on this page?
Please send us a hint about this error by mail to doku@c4b.de. Thank you very much!