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, e-mail addresses, telephone numbers or fax numbers can be entered, separated by commas.

  • It is strongly recommended to use enclosing quotation marks, as special characters (e.g. spaces) often occur in the strings.

• -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

This command does not support input via the pipeline and is therefore 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
Email	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

1. Show all users:

   >Get-XpUsers
   

2. Showing user “Anna Amberg”:

   >Get-XpUsers "Anna Amberg"
   

3. Show all users from the “Sales” department:

   >Get-XpUsers | Where{$_.Department -eq "Vertrieb"}
   

4. Show all users who have never used the mobile client:

   >Get-XpUsers | Where{$_.MobileClientDisplayVersion -eq ""}
   

5. Show all users who are still using an old version of the desktop client:

   >Get-XpUsers | Where{$_.DesktopClientDisplayVersion -ne "9.0.311"}
   

• The version “9.0.311” mentioned in the example must 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 "9.0.311"} | 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 to the object are transferred to the XPhone Connect Server immediately and without further inquiry and stored there.

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.

  • 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 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:

1. The first step gets all users from the XPhone Connect Server (Get-XpUsers).

2. Then the result set is filtered by the department named Development (Where {$_.Department -eq "Development"}).

3. Then, for all those users that are left after filtering, the department is changed to “Software Development” (foreach{$_.Department = "Software Development"}).

4. Finally, the changes are transferred to the XPhone Connect Server and saved (Set-XpUsers).

Get-XpUsersFromADGroups

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 are in the security group but do not exist on the XPhone Connect Server (and vice versa) are not displayed in the results.

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.

  • 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

This command does not support input via the pipeline and is therefore usually at the beginning of a command chain.

Output

The Get-XpUsersFromADGroups command returns a list of type CFGUser[].

Siehe Get-XpUsers.

Example

1. Search for all users on the XPhone Connect Server who are in the AD Security Group Sales:

   >Get-XpUsersFromADGroups "Vertrieb"
   

2. Set the client language to English for all users in the English security group:

   >Get-XpUsersFromADGroups „English" | foreach{$_.Language = "en";$_} | Set-XpUsers
   

Attention

The language change shown in this example only takes effect for the user if they have never manually set a language in their client. Otherwise, the language set by the user has priority.

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!