To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit cc1aa7f7 authored by Aurel Schwitter's avatar Aurel Schwitter

Update help

parent c5cb8635
---
external help file: IAMClient-help.xml
Module Name: IAMClient
online version:
schema: 2.0.0
---
# Add-ETHUserMailAlias
## SYNOPSIS
Adds a new e-mail alias (proxyAddress) to a user's mailbox
## SYNTAX
```
Add-ETHUserMailAlias [-Identity] <String> [-Alias] <String[]> [<CommonParameters>]
```
## DESCRIPTION
Adds a new e-mail alias (proxyAddress) to a user's mailbox, this works by changing the main
e-mail to the new alias and then back to the existing.
!!
WARNING: The Cmdlet currently does not reset the main e-mail address again, because IAM does not work (bug as of 14.02.2020) !!
## EXAMPLES
### EXAMPLE 1
```
Add-ETHUserMailAlias -Identity aurels -Alias "aurels.new@ethz.ch","my_cool_email@micro.biol.ethz.ch"
```
## PARAMETERS
### -Identity
The user to add the alias to
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Alias
The alias(es) to give to the user
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
......@@ -28,7 +28,7 @@ Get-ETHUserGroupMembership aurels
### EXAMPLE 2
```
"aurels","" Get-ETHUserGroupMembership aurels
"aurels","jgrand" | Get-ETHUserGroupMembership
```
## PARAMETERS
......
This diff is collapsed.
......@@ -13,7 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Initialize-IAMClient [-Credentials] <PSCredential> [-Force] [<CommonParameters>]
Initialize-IAMClient [-Credentials] <PSCredential> [-Force] [-EnableDebugOutput] [-ApiHost <String>]
[<CommonParameters>]
```
## DESCRIPTION
......@@ -30,6 +31,21 @@ PS C:\> {{ Add example code here }}
## PARAMETERS
### -ApiHost
{{ Fill ApiHost Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Credentials
{{ Fill Credentials Description }}
......@@ -45,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -EnableDebugOutput
{{ Fill EnableDebugOutput Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Force
{{ Fill Force Description }}
......
......@@ -20,6 +20,9 @@ Locale: en-US
### [Add-ETHUserITService](Add-ETHUserITService.md)
{{ Fill in the Synopsis }}
### [Add-ETHUserMailAlias](Add-ETHUserMailAlias.md)
Adds a new e-mail alias (proxyAddress) to a user's mailbox
### [Clear-ETHMaillistMember](Clear-ETHMaillistMember.md)
{{ Fill in the Synopsis }}
......@@ -87,7 +90,7 @@ Sets the members of an ETH group to the specified member list
{{ Fill in the Synopsis }}
### [Set-ETHUser](Set-ETHUser.md)
{{ Fill in the Synopsis }}
Sets the parameters of an IT-Service for a user (Similar to Set-ADUser)
### [Set-ETHUserITService](Set-ETHUserITService.md)
{{ Fill in the Synopsis }}
......
......@@ -8,7 +8,7 @@ schema: 2.0.0
# Set-ETHUser
## SYNOPSIS
{{ Fill in the Synopsis }}
Sets the parameters of an IT-Service for a user (Similar to Set-ADUser)
## SYNTAX
......@@ -17,21 +17,24 @@ Set-ETHUser [-Identity] <String> [-User] <PSObject> [[-Service] <String>] [<Comm
```
## DESCRIPTION
{{ Fill in the Description }}
Sets all given paramters to the given values
## EXAMPLES
### Example 1
```powershell
PS C:\> {{ Add example code here }}
### EXAMPLE 1
```
$user = Get-ETHUser aurels
```
{{ Add example description here }}
PS C:\\\> $user.homeDrive = "P:"
PS C:\\\> $user.homeDirectory = "\\\\server\share\%username%"
PS C:\\\> $user.profilePath = ""
PS C:\\\> Set-ETHUser -Identity aurels -User $user
## PARAMETERS
### -Identity
{{ Fill Identity Description }}
The username to update
```yaml
Type: String
......@@ -39,39 +42,39 @@ Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Service
{{ Fill Service Description }}
### -User
The modified user object to save, use the output of Get-ETHUser.
```yaml
Type: String
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -User
{{ Fill User Description }}
### -Service
{{ Fill Service Description }}
```yaml
Type: PSObject
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Required: False
Position: 3
Default value: Mailbox
Accept pipeline input: False
Accept wildcard characters: False
```
......@@ -80,11 +83,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### System.Management.Automation.PSObject
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
......@@ -121,3 +121,5 @@ Function Invoke-IAMMethod {
}
}
}
# Connection Cmdlets
# Connection Cmdlets
......
# ETH Group Cmdlets
# ETH Group Cmdlets
......
# ETH Maillist Group
# ETH Maillist Group
......
# Person Cmdlets
# Person Cmdlets
......
# ETH User Cmdlets
# ETH User Cmdlets
......@@ -7,6 +7,7 @@
This group contains the following cmdlets:
- [Add-ETHUserITService](/docs/Add-ETHUserITService.md)
- [Add-ETHUserMailAlias](/docs/Add-ETHUserMailAlias.md)
- [Get-ETHUser](/docs/Get-ETHUser.md)
- [Get-ETHUserGroupMembership](/docs/Get-ETHUserGroupMembership.md)
- [Reset-ETHUserPassword](/docs/Reset-ETHUserPassword.md)
......
function Set-ETHUser {
<#
.SYNOPSIS
Sets the parameters of an IT-Service for a user (Similar to Set-ADUser)
.DESCRIPTION
Sets all given paramters to the given values
.PARAMETER Identity
The username to update
.PARAMETER User
The modified user object to save, use the output of Get-ETHUser.
.EXAMPLE
PS C:\> $user = Get-ETHUser aurels
PS C:\> $user.homeDrive = "P:"
PS C:\> $user.homeDirectory = "\\server\share\%username%"
PS C:\> $user.profilePath = ""
PS C:\> Set-ETHUser -Identity aurels -User $user
#>
[CmdletBinding()]
param (
[Parameter(Position = 0, Mandatory = 1)]
......
# Initialization Cmdlets
# Initialization Cmdlets
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment