en-US/Microsoft.PowerShell.SecretStore.dll-Help.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SecretStoreConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>SecretStoreConfiguration</command:noun> <maml:description> <maml:para>Returns SecretStore configuration information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet reads the SecretStore configuration file and writes configuration information to the pipeline. Configuration information includes:</maml:para> <maml:para>- Scope</maml:para> <maml:para>- Authentication</maml:para> <maml:para>- PasswordTimeout (in seconds)</maml:para> <maml:para>- Interaction</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SecretStoreConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerShell.SecretStore.SecureStoreConfig</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>'AllUsers' scope is currently not supported. Configuration scope is always 'CurrentUser'.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretStoreConfiguration Scope Authentication PasswordTimeout Interaction ----- -------------- --------------- ----------- CurrentUser Password 900 Prompt</dev:code> <dev:remarks> <maml:para>This example runs the command from a command shell prompt and displays four SecretStore configuration properties: Scope : 'CurrentUser'. Authentication : A password is required to access the SecretStore. PasswordTimeout : The session password timeout time is 15 minutes. Interaction : The user will be prompted for a password if the command is run in an interactive session. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-SecretStore</command:name> <command:verb>Reset</command:verb> <command:noun>SecretStore</command:noun> <maml:description> <maml:para>Resets the SecretStore by deleting all secret data and configuring the store with default options.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet completely resets the SecretStore by deleting all secret data it may contain, and resetting configuration options to their default values. It is intended to be used only if a required password is lost, or data files become corrupted so that SecretStore no longer functions and secret data cannot be accessed. Default configuration options can be overridden by specifying individual command configuration option parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-SecretStore</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authentication</maml:name> <maml:Description> <maml:para>Configuration option to set authentication for store access. Configuration options are 'Password' or 'None'. When 'Password' is selected, SecretStore is configured to require a password for accessing secrets. Default authentication is 'Password', as this provides the strongest protection of secret data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Authenticate</command:parameterValue> <dev:type> <maml:name>Authenticate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Password</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>When used, the user will not be asked to confirm and the SecretStore will be reset without prompting. Default value is false, and user will be asked to confirm the operation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Sets the provided Password to the newly reset store. If the reset store is not configured for password authentication, an error will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Writes the newly reset store configuration object (SecureStorConfig) to the pipeline.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>Configuration option that provides the session password timeout in seconds. Takes an argument whose value determines the session password timeout in seconds. When the timeout value is reached, the current password value is invalidated for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>900</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Configuration option that determines SecretStore operation scope. Currently only 'CurrentUser' scope is supported.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUsers</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SecureStoreScope</command:parameterValue> <dev:type> <maml:name>SecureStoreScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CurrentUser</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interaction</maml:name> <maml:Description> <maml:para>Configuration option to allow or suppress user prompting. Configuration options are 'Prompt' or 'None'. When 'None' is selected, no prompt will be presented in an interactive session to provide a session password. Default value is 'Prompt', and users will be prompted for password when needed. When 'None' is selected and a session password is required, a Microsoft.PowerShell.SecretStore.PasswordRequiredException error is thrown.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Interaction</command:parameterValue> <dev:type> <maml:name>Interaction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Prompt</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authentication</maml:name> <maml:Description> <maml:para>Configuration option to set authentication for store access. Configuration options are 'Password' or 'None'. When 'Password' is selected, SecretStore is configured to require a password for accessing secrets. Default authentication is 'Password', as this provides the strongest protection of secret data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Authenticate</command:parameterValue> <dev:type> <maml:name>Authenticate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Password</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>When used, the user will not be asked to confirm and the SecretStore will be reset without prompting. Default value is false, and user will be asked to confirm the operation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Sets the provided Password to the newly reset store. If the reset store is not configured for password authentication, an error will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Writes the newly reset store configuration object (SecureStorConfig) to the pipeline.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>Configuration option that provides the session password timeout in seconds. Takes an argument whose value determines the session password timeout in seconds. When the timeout value is reached, the current password value is invalidated for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>900</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Configuration option that determines SecretStore operation scope. Currently only 'CurrentUser' scope is supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureStoreScope</command:parameterValue> <dev:type> <maml:name>SecureStoreScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CurrentUser</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interaction</maml:name> <maml:Description> <maml:para>Configuration option to allow or suppress user prompting. Configuration options are 'Prompt' or 'None'. When 'None' is selected, no prompt will be presented in an interactive session to provide a session password. Default value is 'Prompt', and users will be prompted for password when needed. When 'None' is selected and a session password is required, a Microsoft.PowerShell.SecretStore.PasswordRequiredException error is thrown.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Interaction</command:parameterValue> <dev:type> <maml:name>Interaction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Prompt</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerShell.SecretStore.SecureStoreConfig</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Reset-SecretStore -PassThru WARNING: !!This operation will completely remove all SecretStore module secrets and reset configuration settings to default values!! Reset SecretStore Are you sure you want to erase all secrets in SecretStore and reset configuration settings to default? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): Y Creating a new Microsoft.PowerShell.SecretStore vault. A password is required by the current store configuration. Enter password: ******** Enter password again for verification: ******** Scope Authentication PasswordTimeout Interaction ----- -------------- --------------- ----------- CurrentUser Password 900 Prompt</dev:code> <dev:remarks> <maml:para>This example resets the SecretStore for the current user, by deleting all secrets and forcing configuration settings to default values. The user is warned of the consequences of this action and prompted to confirm before continuing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SecretStoreConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>SecretStoreConfiguration</command:noun> <maml:description> <maml:para>Sets SecretStore configuration properties.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet takes individual parameter arguments that determine SecretStore configuration. Or the '-Default' parameter can be used to restore SecretStore configuration to default settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SecretStoreConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authentication</maml:name> <maml:Description> <maml:para>Configuration option to set authentication for store access. Configuration options are 'Password' or 'None'. When 'Password' is selected, SecretStore is configured to require a password for accessing secrets. Default authentication is 'Password', as this provides the strongest protection of secret data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Authenticate</command:parameterValue> <dev:type> <maml:name>Authenticate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Password</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>When used, the user will not be asked to confirm and the SecretStore will be reset without prompting. Default value is false, and user will be asked to confirm the operation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When used, will write the current SecretStore configuration to the pipeline.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>Configuration option that provides the session password timeout in seconds. Takes an argument whose value determines the session password timeout in seconds. When the timeout value is reached, the current password value is invalidated for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Configuration option that determines SecretStore operation scope. Currently only 'CurrentUser' scope is supported.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUsers</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SecureStoreScope</command:parameterValue> <dev:type> <maml:name>SecureStoreScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interaction</maml:name> <maml:Description> <maml:para>Configuration option to allow or suppress user prompting. Configuration options are 'Prompt' or 'None'. When 'None' is selected, no prompt will be presented in an interactive session to provide a session password. Default value is 'Prompt', and users will be prompted for password when needed. When 'None' is selected and a session password is required, a Microsoft.PowerShell.SecretStore.PasswordRequiredException error is thrown.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Interaction</command:parameterValue> <dev:type> <maml:name>Interaction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SecretStoreConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Default</maml:name> <maml:Description> <maml:para>This parameter switch sets SecretStore configuration to its default settings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>When used, the user will not be asked to confirm and the SecretStore will be reset without prompting. Default value is false, and user will be asked to confirm the operation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When used, will write the current SecretStore configuration to the pipeline.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authentication</maml:name> <maml:Description> <maml:para>Configuration option to set authentication for store access. Configuration options are 'Password' or 'None'. When 'Password' is selected, SecretStore is configured to require a password for accessing secrets. Default authentication is 'Password', as this provides the strongest protection of secret data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Authenticate</command:parameterValue> <dev:type> <maml:name>Authenticate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Password</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Default</maml:name> <maml:Description> <maml:para>This parameter switch sets SecretStore configuration to its default settings.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>When used, the user will not be asked to confirm and the SecretStore will be reset without prompting. Default value is false, and user will be asked to confirm the operation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When used, will write the current SecretStore configuration to the pipeline.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>Configuration option that provides the session password timeout in seconds. Takes an argument whose value determines the session password timeout in seconds. When the timeout value is reached, the current password value is invalidated for the session.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Configuration option that determines SecretStore operation scope. Currently only 'CurrentUser' scope is supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureStoreScope</command:parameterValue> <dev:type> <maml:name>SecureStoreScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interaction</maml:name> <maml:Description> <maml:para>Configuration option to allow or suppress user prompting. Configuration options are 'Prompt' or 'None'. When 'None' is selected, no prompt will be presented in an interactive session to provide a session password. Default value is 'Prompt', and users will be prompted for password when needed. When 'None' is selected and a session password is required, a Microsoft.PowerShell.SecretStore.PasswordRequiredException error is thrown.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Interaction</command:parameterValue> <dev:type> <maml:name>Interaction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerShell.SecretStore.SecureStoreConfig</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-SecretStoreConfiguration -Default Confirm Are you sure you want to perform this action? Performing the operation "Changes local store configuration" on target "SecretStore module local store". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y Scope Authentication PasswordTimeout Interaction ----- -------------- --------------- ----------- CurrentUser Password 900 Prompt</dev:code> <dev:remarks> <maml:para>This example uses the command to restore the SecretStore configuration settings to their default values.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SecretStorePassword</command:name> <command:verb>Set</command:verb> <command:noun>SecretStorePassword</command:noun> <maml:description> <maml:para>Replaces the current SecretStore password with a new one.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet updates the password for SecretStore. It takes no parameters and prompts the user for both the old and new passwords.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SecretStorePassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="named" aliases="none"> <maml:name>NewPassword</maml:name> <maml:Description> <maml:para>New password to be applied to the store.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Existing password needed to unlock the store. This can be ignored if the store doesn't currently use a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="named" aliases="none"> <maml:name>NewPassword</maml:name> <maml:Description> <maml:para>New password to be applied to the store.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Existing password needed to unlock the store. This can be ignored if the store doesn't currently use a password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-SecretStorePassword Old password Enter password: ******* New password Enter password: ******* Enter password again for verification: *******</dev:code> <dev:remarks> <maml:para>This example runs the command with no parameter arguments. The user is first prompted for the old password. And then prompted for the new password twice for verification.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-SecretStorePassword -NewPassword $newPassword -Password $oldPassword</dev:code> <dev:remarks> <maml:para>This example runs the command passing in both the current store password and the new password to be set.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unlock-SecretStore</command:name> <command:verb>Unlock</command:verb> <command:noun>SecretStore</command:noun> <maml:description> <maml:para>Unlocks SecretStore with the provided password.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet unlocks SecretStore for the current user with the provided password. It can be used to unlock SecretStore when the configuration requires a password and the prompt configuration option is disabled. The provided password will be applied to the current session, and will become invalid after the 'PasswordTimeout' time elapses. If no password is provided by parameter argument, the user will be safely prompted for the password.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unlock-SecretStore</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>This parameter takes the password argument as a SecureString object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>This parameter takes a password timeout argument in seconds, and overrides the configuration password timeout value. The password timeout value remains in effect for the session until changed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>This parameter takes the password argument as a SecureString object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordTimeout</maml:name> <maml:Description> <maml:para>This parameter takes a password timeout argument in seconds, and overrides the configuration password timeout value. The password timeout value remains in effect for the session until changed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Secret secret1 -Vault LocalStore Get-Secret: A valid password is required to access the Microsoft.PowerShell.SecretStore vault. Get-Secret: The secret secret1 was not found. PS C:\> Unlock-SecretStore cmdlet Unlock-SecretStore at command pipeline position 1 Supply values for the following parameters: SecureStringPassword: ******* PS C:\> Get-Secret secret1 -Vault LocalStore System.Security.SecureString</dev:code> <dev:remarks> <maml:para>In this example, the SecretManagement 'Get-Secret' command fails to retrieve secret1 because the SecretStore vault is locked. The 'Unlock-SecretStore' command is run to unlock the vault. No password parameter argument was provided to the 'Unlock-SecretStore' command, so the user is prompted for the password. Running 'Get-Secret' again now works and returns the secret as a SecureString object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |