host-group

Add-CsGroupMember

Add Hosts to a static Host Group

References

Documentation, Swagger

Parameters

-Id: The Host Group ID

-Hosts: One or more Agent IDs to add to the Host Group

Example

PS> Add-CsGroupMember -Id <string> -Hosts @(<string>, <string>)

Edit-CsGroup

Update Host Groups by specifying the ID of the group and details to update

References

Swagger

Parameters

-Resources: An array of Host Group properties

Example

PS> Edit-CsGroup -Resources @(@{ id = <string>; assignment_rule = <string> }),

Get-CsGroupId

Search for Host Groups IDs

References

Documentation, Swagger

Parameters

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 500]

-Offset: The offset to start retrieving records from [default: 0]

-All: Repeat request until all results are returned

Example

PS> Get-CsGroupId

Get-CsGroupInfo

Search for info about Host Groups

References

Swagger

Parameters

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 500]

-Offset: The offset to start retrieving records from [default: 0]

-Id: IDs of specific host groups to return

-All: Repeat request until all results are returned

Example

PS> Get-CsGroupInfo

Get-CsGroupMemberId

Search for members of a Host Group in your environment

References

Swagger

Parameters

-Id: The ID of the Host Group to search for members of

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 5000]

-Offset: The offset to start retrieving records from [default: 0]

-All: Repeat request until all results are returned

Example

PS> Get-CsGroupMemberId -Id <string>

Get-CsGroupMemberInfo

Search for detail about members of a Host Group in your environment

References

Swagger

Parameters

-Id: The ID of the Host Group to search for members of

-Filter: The filter expression that should be used to limit the results

-Limit: The maximum records to return [default: 5000]

-Offset: The offset to start retrieving records from [default: 0]

-All: Repeat request until all results are returned

Example

PS> Get-CsGroupMemberInfo -Id <string>

New-CsGroup

Create Host Groups by specifying details about the group to create

References

Documentation, Swagger

Parameters

-Resources: An array of Host Group properties

Example

PS> New-CsGroup -Resources @(@{ name = <string>; description = <string> })

Remove-CsGroup

Delete a set of Host Groups by specifying their IDs

References

Swagger

Parameters

-Id: An array of IDs of the Host Groups to delete

Example

PS> Remove-CsGroup -Id @(<string>, <string>)

Remove-CsGroupMember

Remove hosts from a static group

References

Swagger

Parameters

-Id: The Host Group ID

-Hosts: One or more agent IDs to remove from the group

Example

PS> Remove-CsGroupMember -Id <string> -Hosts @(<string>, <string>)