Get-NIOSFileOp¶
SYNOPSIS¶
Generic Wrapper function for retrieving files from the NIOS WAPI
SYNTAX¶
Get-NIOSFileOp [-Function] <String> [[-Data] <Object>] [[-Path] <String>] [-Download] [[-Server] <String>]
[[-GridUID] <String>] [[-GridName] <String>] [[-ApiVersion] <String>] [-SkipCertificateCheck]
[[-Creds] <PSCredential>] [<CommonParameters>]
DESCRIPTION¶
Generic Wrapper function for retrieving files from the NIOS WAPI, either directly or via BloxOne Federation
EXAMPLES¶
EXAMPLE 1¶
$Data = @{"log_type" = "SYSLOG"; "member" = "grid-member.fqdn.corp"; "node_type" = "ACTIVE"}
Get-NIOSFileOp -Function 'get_log_files' -Data $Data -Download
PARAMETERS¶
-Function¶
The File Operation to perform, i.e 'get_log_files'
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Data¶
The HTTP Body to submit as part of the File Operation. This should be in [Object] format, as it gets converted to JSON by this function.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path¶
The file path to use when specifying the -Download option. Defaults to the current directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: ./
Accept pipeline input: False
Accept wildcard characters: False
-Download¶
Switch parameter to indicate whether to download the file.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Server¶
Specify the NIOS Grid Manager IP or FQDN to use
This parameter can be ommitted if the Server is stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GridUID¶
Specify the NIOS Grid UID (license_uid). This indicates which Grid to connect to when using NIOS Federation within BloxOne.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GridName¶
Specify the NIOS Grid Name in BloxOne DDI instead of the GridUID. This is convient, but requires resolving the license_uid on every API Call.
This parameter can be ommitted if the Federated Grid has been stored by using Set-NIOSConnectionProfile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiVersion¶
The version of the NIOS API to use (WAPI)
This parameter can be ommitted if the API Version is stored by using Set-NIOSConnectionProfile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipCertificateCheck¶
If this parameter is set, SSL Certificates Checks will be ignored.
This parameter can be ommitted if the configuration has been stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Creds¶
The creds parameter can be used to specify credentials as part of the command.
This parameter can be ommitted if the Credentials are stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
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.