| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Set-IntersightIamUserGroup [-AccessActivationTime< DateTime>][-AccessExpiryTime< DateTime>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-GroupType< IamUserGroup.GroupTypeEnum>][-Idp< IamIdpRelationship>][-Idpreference< IamIdpReferenceRelationship>][-Instruction< string>][[-Moid]< string>][-Name< string>][-Permissions< System.Collections.Generic.List`1[IamPermissionRelationship]>][-Qualifier< IamAbstractQualifierRelationship>][-Tags< System.Collections.Generic.List`1[MoTag]>][-IfMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Update a 'IamUserGroup' resource.
AccessActivationTime indicates the activation time for the guest user's access to the Account. Before this time, if guest user tries to login to the account, access the account will be denied.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAccessExpiryTime indicates the expiration time for the guest user's access to the Account. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured for the API entries. The AccessExpiry date can be edited to be earlier or later.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseType: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseGroup type determines the type of groups that is being associated with users. By default, Default User group will be used for associating dynamic user login. If the value of the User Group is set to guest, then this type of user group will be used for guest user login.\n* Default - Default User Group Type used for dynamic users login.\n* Guest - Guest User Group type used for guest users login.
Type: IamUserGroup.GroupTypeEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.
Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.
Type: IamIdpRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.
Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.
Type: IamIdpReferenceRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseInstruction property holds detailed guidance and information intended for individuals accessing the system as guest users. It holds the information to assist guests in navigating the platform, understanding policies, and performing necessary actions to ensure a seamless and secure user experience.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe unique identifier of this Managed Object instance.
Type: string
Parameter Sets: (All)
Aliases:
Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe name of the user group which the dynamic/or guest user belongs to.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAn array of relationships to iamPermission resources.
Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.
Type: System.Collections.Generic.List`1[IamPermissionRelationship]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA reference to a iamAbstractQualifier resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.
Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.
Type: IamAbstractQualifierRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseNote :- Use Initialize-IntersightMoTag to create the object of complex type MoTag
Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseFor methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
Type: String
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the json payload received in response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the HTTP response with headers and content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
PS C:\> Set-IntersightIamUserGroup{ Add example description here }