forked from OCram85/PSCredentialStore
Marco Blessing
b76668c1e7
#### 📖 Summary - `Test-CredentialStoreItem` now returns `$false` and not a terminating error if store doesn't exists. - Updates platyPS generated docs #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes - fixes #50 Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: OCram85/PSCredentialStore#66
157 lines
2.8 KiB
Markdown
157 lines
2.8 KiB
Markdown
---
|
|
external help file: ModuleRoot-help.xml
|
|
Module Name: PSCredentialStore
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# New-CSCertAttribute
|
|
|
|
## SYNOPSIS
|
|
Creates required data for a certificate signing request.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
New-CSCertAttribute [-Country] <String> [-State] <String> [-City] <String> [-Organization] <String>
|
|
[-OrganizationalUnitName] <String> [-CommonName] <String> [[-Days] <Int32>] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Defines the certificate related properties for an upcoming New-PfxCertificate execution.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
$AttribParams = @{
|
|
Country = 'DE'
|
|
State = 'BW'
|
|
City = 'Karlsruhe'
|
|
Organization ='AwesomeIT'
|
|
OrganizationalUnitName ='PSCredentialStore'
|
|
CommonName ='MyPrivateCert'
|
|
}
|
|
New-CSCertAttribute @AttribParams
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -City
|
|
Certificate city value.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 3
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -CommonName
|
|
The certificate common name.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 6
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Country
|
|
County code like EN, DE, IT, FR...
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 1
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Days
|
|
The validation time itself.
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: 7
|
|
Default value: 365
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Organization
|
|
Certificate organization value.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 4
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -OrganizationalUnitName
|
|
Certificate OrganizationalUnitName value.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 5
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -State
|
|
Certificate state value.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 2
|
|
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](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
### [None]
|
|
## OUTPUTS
|
|
|
|
### [PSCredentialStore.Certificate.CSRDetails]
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|