Knowledge Base Article

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets a knowledge base article from the NinjaOne API.

SYNTAX

Download (Default)

Get-NinjaOneKnowledgeBaseArticle [-articleId] <Int32> [-signedUrls] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Details

Get-NinjaOneKnowledgeBaseArticle [-articleId] <Int32> [-details] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Downloads a knowledge base article from the NinjaOne v2 API by default. Use -details to retrieve the article object or -signedUrls to retrieve signed URLs.

EXAMPLES

EXAMPLE 1

Get-NinjaOneKnowledgeBaseArticle -articleId 1

Gets the knowledge base article with id 1.

EXAMPLE 2

Get-NinjaOneKnowledgeBaseArticle -articleId 1 -details

Gets the article object for the knowledge base article with id 1.

PARAMETERS

-articleId

The knowledge base article id to get.

Type: Int32
Parameter Sets: (All)
Aliases: id

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-signedUrls

Get a map of content ids and their corresponding signed urls.

Type: SwitchParameter
Parameter Sets: Download
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-details

Get the article object instead of downloading its content.

Type: SwitchParameter
Parameter Sets: Details
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
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.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/knowledgebasearticle