< Back
Get-GlpiToolsDocuments
Post
NAME Get-GlpiToolsDocuments
SYNOPSIS
Function is getting Document informations from GLPI
SYNTAX
Get-GlpiToolsDocuments [-DocumentId] <Int32[]> [<CommonParameters>]
Get-GlpiToolsDocuments [-All] [<CommonParameters>]
Get-GlpiToolsDocuments [-DocumentId <Int32[]>] [[-RawDocument]] [<CommonParameters>]
Get-GlpiToolsDocuments [-DocumentId <Int32[]>] [[-Raw]] [<CommonParameters>]
DESCRIPTION
Function is based on DocumentID which you can find in GLPI website
Returns object with property's of document.
PARAMETERS
-All [<SwitchParameter>]
This parameter will return all documents from GLPI
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DocumentId <Int32[]>
This parameter can take pipline input, either, you can use this function with -DocumentId keyword.
Provide to this param Document ID from GLPI Documents Bookmark
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Raw [<SwitchParameter>]
Parameter which you can use with DocumentId Parameter.
DocumentId has converted parameters from default, parameter Raw allows not convert this parameters.
Required? false
Position? 2
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RawDocument [<SwitchParameter>]
Parameter which you can use with DocumentId Parameter.
This parameter get document and return what document has inside.
Required? false
Position? 2
Default value False
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
Document ID which you can find in GLPI, or use this Function to convert ID returned from other Functions
OUTPUTS
Function returns PSCustomObject with property's of document's from GLPI
NOTES
PSP 05/2019
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GlpiToolsDocuments -All
Example will show all documents from Document GLPI Bookmark.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2
Example will return object of document which id is 2. Example will convert values to human readable.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2 -Raw
Example will return object of document which id is 2. Example will not convert values to human readable.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2 -RawDocument
Example will return content which document has inside the file.
RELATED LINKS
SYNOPSIS
Function is getting Document informations from GLPI
SYNTAX
Get-GlpiToolsDocuments [-DocumentId] <Int32[]> [<CommonParameters>]
Get-GlpiToolsDocuments [-All] [<CommonParameters>]
Get-GlpiToolsDocuments [-DocumentId <Int32[]>] [[-RawDocument]] [<CommonParameters>]
Get-GlpiToolsDocuments [-DocumentId <Int32[]>] [[-Raw]] [<CommonParameters>]
DESCRIPTION
Function is based on DocumentID which you can find in GLPI website
Returns object with property's of document.
PARAMETERS
-All [<SwitchParameter>]
This parameter will return all documents from GLPI
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DocumentId <Int32[]>
This parameter can take pipline input, either, you can use this function with -DocumentId keyword.
Provide to this param Document ID from GLPI Documents Bookmark
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Raw [<SwitchParameter>]
Parameter which you can use with DocumentId Parameter.
DocumentId has converted parameters from default, parameter Raw allows not convert this parameters.
Required? false
Position? 2
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RawDocument [<SwitchParameter>]
Parameter which you can use with DocumentId Parameter.
This parameter get document and return what document has inside.
Required? false
Position? 2
Default value False
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
Document ID which you can find in GLPI, or use this Function to convert ID returned from other Functions
OUTPUTS
Function returns PSCustomObject with property's of document's from GLPI
NOTES
PSP 05/2019
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GlpiToolsDocuments -All
Example will show all documents from Document GLPI Bookmark.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2
Example will return object of document which id is 2. Example will convert values to human readable.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2 -Raw
Example will return object of document which id is 2. Example will not convert values to human readable.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-GlpiToolsDocuments -ComputerId 2 -RawDocument
Example will return content which document has inside the file.
RELATED LINKS