< Back
Get-ItGlueOrganization
Post
NAME Get-ItGlueOrganization
SYNOPSIS
SYNTAX
Get-ItGlueOrganization [-CustomerName <String>] [-CustomerId <Int64>] -ApiKey <SecureString> [-UriBase <String>]
[-PageSize <Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]
Get-ItGlueOrganization [-CustomerName <String>] [-CustomerId <Int64>] -UserCred <PSCredential> [-UriBase <String>]
[-PageSize <Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]
DESCRIPTION
Connects to the ITGlue API and returns one or organizations.
PARAMETERS
-CustomerName <String>
Enter the name of the desired customer, or "All" to retrieve all organizations.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerId <Int64>
Desired customer's ITGlue organization ID.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ApiKey <SecureString>
ITGlue API key used to send data to ITGlue.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserCred <PSCredential>
ITGlue credential object for the desired local account.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UriBase <String>
Base URL for the ITGlue API.
Required? false
Position? named
Default value https://api.itglue.com
Accept pipeline input? false
Accept wildcard characters? false
-PageSize <Int64>
Page size when requesting ITGlue resources via the API.
Required? false
Position? named
Default value 1000
Accept pipeline input? false
Accept wildcard characters? false
-EventLogSource <String>
When included, (and when LogPath is null), represents the event log source for the Application log. If no
event log source or path are provided, output is sent only to the host.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogPath <String>
When included (when EventLogSource is null), represents the file, to which the cmdlet will output will be
logged. If no path or event log source are provided, output is sent only to the host.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
V1.0.0.0 date: 5 April 2019
- Initial release.
V1.0.0.1 date: 24 April 2019
- Added $MaxLoopCount parameter.
V1.0.0.2 date: 20 May 2019
- Updated rate-limit detection.
V1.0.0.3 date: 24 May 2019
- Updated formatting.
- Updated date calculation.
V1.0.0.4 date: 31 May 2019
- Updated log verbiage.
- Fixed bug in loop incrementing.
V1.0.0.5 date: 11 July 2019
V1.0.0.6 date: 18 July 2019
V1.0.0.7 date: 25 July 2019
V1.0.0.8 date: 1 August 2019
V1.0.0.9 date: 6 August 2019
V1.0.0.10 date: 9 August 2019
V1.0.0.11 date: 13 August 2019
V1.0.0.12 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ItGlueOrganization -ItGlueApiKey ITG.XXXXXXXXXXXXX -CustomerName All
In this example, the cmdlet will get all of the organzations in the instance. Output is sent to the host session
and event log.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ItGlueOrganization -UserCred (Get-Credential) -ComputerName company1 -Verbose
In this example, the cmdlet will get all of the organzations in the instance, with the name "company1". Verbose
output is sent to the host.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-ItGlueOrganization -UserCred (Get-Credential) -CustomerId 123456 -BlockLogging -LogPath C:\\Temp\\log.txt
In this example, the cmdlet will get the customer with ID 123456, using the provided ITGlue user credentials.
Output will be written to the log file and host.
RELATED LINKS
https://github.com/wetling23/Public.ItG ... hellModule
SYNOPSIS
SYNTAX
Get-ItGlueOrganization [-CustomerName <String>] [-CustomerId <Int64>] -ApiKey <SecureString> [-UriBase <String>]
[-PageSize <Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]
Get-ItGlueOrganization [-CustomerName <String>] [-CustomerId <Int64>] -UserCred <PSCredential> [-UriBase <String>]
[-PageSize <Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]
DESCRIPTION
Connects to the ITGlue API and returns one or organizations.
PARAMETERS
-CustomerName <String>
Enter the name of the desired customer, or "All" to retrieve all organizations.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerId <Int64>
Desired customer's ITGlue organization ID.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ApiKey <SecureString>
ITGlue API key used to send data to ITGlue.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserCred <PSCredential>
ITGlue credential object for the desired local account.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UriBase <String>
Base URL for the ITGlue API.
Required? false
Position? named
Default value https://api.itglue.com
Accept pipeline input? false
Accept wildcard characters? false
-PageSize <Int64>
Page size when requesting ITGlue resources via the API.
Required? false
Position? named
Default value 1000
Accept pipeline input? false
Accept wildcard characters? false
-EventLogSource <String>
When included, (and when LogPath is null), represents the event log source for the Application log. If no
event log source or path are provided, output is sent only to the host.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogPath <String>
When included (when EventLogSource is null), represents the file, to which the cmdlet will output will be
logged. If no path or event log source are provided, output is sent only to the host.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
V1.0.0.0 date: 5 April 2019
- Initial release.
V1.0.0.1 date: 24 April 2019
- Added $MaxLoopCount parameter.
V1.0.0.2 date: 20 May 2019
- Updated rate-limit detection.
V1.0.0.3 date: 24 May 2019
- Updated formatting.
- Updated date calculation.
V1.0.0.4 date: 31 May 2019
- Updated log verbiage.
- Fixed bug in loop incrementing.
V1.0.0.5 date: 11 July 2019
V1.0.0.6 date: 18 July 2019
V1.0.0.7 date: 25 July 2019
V1.0.0.8 date: 1 August 2019
V1.0.0.9 date: 6 August 2019
V1.0.0.10 date: 9 August 2019
V1.0.0.11 date: 13 August 2019
V1.0.0.12 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ItGlueOrganization -ItGlueApiKey ITG.XXXXXXXXXXXXX -CustomerName All
In this example, the cmdlet will get all of the organzations in the instance. Output is sent to the host session
and event log.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ItGlueOrganization -UserCred (Get-Credential) -ComputerName company1 -Verbose
In this example, the cmdlet will get all of the organzations in the instance, with the name "company1". Verbose
output is sent to the host.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-ItGlueOrganization -UserCred (Get-Credential) -CustomerId 123456 -BlockLogging -LogPath C:\\Temp\\log.txt
In this example, the cmdlet will get the customer with ID 123456, using the provided ITGlue user credentials.
Output will be written to the log file and host.
RELATED LINKS
https://github.com/wetling23/Public.ItG ... hellModule