< Back
Set-ArchivialNetworkCredential
Post
NAME Set-ArchivialNetworkCredential
SYNOPSIS
Saves the credentials required to connect to an authenticated network resource (such as a UNC path share).
SYNTAX
Set-ArchivialNetworkCredential -CredentialName <string> -SharePassword <string> -ShareUsername <string>
[<CommonParameters>]
DESCRIPTION
Network Sources can be authenticated (require username/password), or unauthenticated (open access). If this
Network Source requires authenticated access, you must provide use this command to pre-store the authentication
details so the backup engine can connect to the resource.
The credential username and password are both encrypted and saved to the database.
PARAMETERS
-CredentialName <string>
Specify the friendly name (description) to refer to this stored credential.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ShareUsername <string>
Specify the username required to connect to the network resource.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SharePassword <string>
Specify the password required to connect to the network resource.
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, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword
****
Encrypts and stores the network resource credentials in the database.
RELATED LINKS
SYNOPSIS
Saves the credentials required to connect to an authenticated network resource (such as a UNC path share).
SYNTAX
Set-ArchivialNetworkCredential -CredentialName <string> -SharePassword <string> -ShareUsername <string>
[<CommonParameters>]
DESCRIPTION
Network Sources can be authenticated (require username/password), or unauthenticated (open access). If this
Network Source requires authenticated access, you must provide use this command to pre-store the authentication
details so the backup engine can connect to the resource.
The credential username and password are both encrypted and saved to the database.
PARAMETERS
-CredentialName <string>
Specify the friendly name (description) to refer to this stored credential.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ShareUsername <string>
Specify the username required to connect to the network resource.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SharePassword <string>
Specify the password required to connect to the network resource.
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, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword
****
Encrypts and stores the network resource credentials in the database.
RELATED LINKS