Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcSecuritySsh


NAME
Get-NcSecuritySsh

SYNOPSIS
Get SSH configuration options.

SYNTAX
Get-NcSecuritySsh [[-Vserver] <String[]>] [-Attributes <SecuritySshInfo>] [-
VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcSecuritySsh -Template [-VserverContext <String>] [-Controller <NcContr
oller[]>] [<CommonParameters>]

Get-NcSecuritySsh -Query <SecuritySshInfo> [-Attributes <SecuritySshInfo>] [
-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters>
]


DESCRIPTION
Get SSH configuration options.


PARAMETERS
-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <SecuritySshInfo>
For improved scalability in large clusters, provide a SecuritySshInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcSecurit
ySsh -Template" to get the initially empty SecuritySshInfo object. If n
ot specified, all data is returned for each object.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Template
Specify to get an empty SecuritySshInfo object for use with advanced que
ries involving the Query attribute.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <SecuritySshInfo>
For advanced queries, provide a SecuritySshInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcSecuritySsh -Template" to get the initially e
mpty SecuritySshInfo object.

Required? true
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 and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.Types.Security.SecuritySshInfo


NOTES


Category: security
API: security-ssh-get-iter
Family: cluster,vserver

-------------- Example 1 --------------

C:\PS>Get-NcSecuritySsh


Get the SSH security configuration for all the Vservers in the current clust
er.


Ciphers KeyExchangeAlgorithms NcController
VserverName
------- --------------------- ------------
-----------
{aes256_ctr, aes192_ctr, a... {diffie_hellman_group_exch... 10.63.58.22
beam_vsim01
{aes256_ctr, aes192_ctr, a... {diffie_hellman_group_exch... 10.63.58.22
vsim_cluster1


-------------- Example 2 --------------

C:\PS>$q = Get-NcSecuritySsh -Template
$q.Ciphers = @("aes192_ctr")
Get-NcSecuritySsh -Query $q


Get the SSH security settings that contain the given cipher for all the Vser
vers in the current cluster.


Ciphers KeyExchangeAlgorithms NcController
VserverName
------- --------------------- ------------
-----------
{aes256_ctr, aes192_ctr, a... {diffie_hellman_group_exch... 10.63.58.22
beam_vsim01
{aes256_ctr, aes192_ctr, a... {diffie_hellman_group_exch... 10.63.58.22
vsim_cluster1



RELATED LINKS
Set-NcSecuritySsh







 Data ONTAP® PowerShell Toolkit