diff --git a/CHANGELOG.md b/CHANGELOG.md index 502a6fd14a44..ade51b3859d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,23 @@ Versions are `MAJOR.PATCH`. # Changelog +Salt 3003.5 (2022-07-05) +======================== + +Fixed +----- + +- Update Markup and contextfunction imports for jinja versions >=3.1. (#61848) +- Fix bug in tcp transport (#61865) +- Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. (#61868) + + +Security +-------- + +- Fixed PAM auth to reject auth attempt if user account is locked. (cve-2022-22967) + + Salt 3003.4 (2022-02-25) ======================== diff --git a/changelog/61848.fixed b/changelog/61848.fixed deleted file mode 100644 index e8e6fd34262c..000000000000 --- a/changelog/61848.fixed +++ /dev/null @@ -1 +0,0 @@ -Update Markup and contextfunction imports for jinja versions >=3.1. diff --git a/changelog/61865.fixed b/changelog/61865.fixed deleted file mode 100644 index 2e994bcda487..000000000000 --- a/changelog/61865.fixed +++ /dev/null @@ -1 +0,0 @@ -Fix bug in tcp transport diff --git a/changelog/61868.fixed b/changelog/61868.fixed deleted file mode 100644 index 0169c48e99d2..000000000000 --- a/changelog/61868.fixed +++ /dev/null @@ -1 +0,0 @@ -Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. diff --git a/changelog/cve-2022-22967.security b/changelog/cve-2022-22967.security deleted file mode 100644 index 52943680f448..000000000000 --- a/changelog/cve-2022-22967.security +++ /dev/null @@ -1 +0,0 @@ -Fixed PAM auth to reject auth attempt if user account is locked. diff --git a/doc/man/salt-api.1 b/doc/man/salt-api.1 index 8c6daa1a7a86..4c13e93a4247 100644 --- a/doc/man/salt-api.1 +++ b/doc/man/salt-api.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-API" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-API" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-api \- salt-api Command . diff --git a/doc/man/salt-call.1 b/doc/man/salt-call.1 index 0ead84b2bffc..82043d86fb4e 100644 --- a/doc/man/salt-call.1 +++ b/doc/man/salt-call.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CALL" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-CALL" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-call \- salt-call Documentation . diff --git a/doc/man/salt-cloud.1 b/doc/man/salt-cloud.1 index 453c2f01cd41..7d23f229e272 100644 --- a/doc/man/salt-cloud.1 +++ b/doc/man/salt-cloud.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CLOUD" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-CLOUD" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-cloud \- Salt Cloud Command . diff --git a/doc/man/salt-cp.1 b/doc/man/salt-cp.1 index 95b6f8e03611..210447d93ce0 100644 --- a/doc/man/salt-cp.1 +++ b/doc/man/salt-cp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CP" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-CP" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-cp \- salt-cp Documentation . diff --git a/doc/man/salt-key.1 b/doc/man/salt-key.1 index c5c1954ad591..9e774a32cdf3 100644 --- a/doc/man/salt-key.1 +++ b/doc/man/salt-key.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-KEY" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-KEY" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-key \- salt-key Documentation . diff --git a/doc/man/salt-master.1 b/doc/man/salt-master.1 index 47c9887e170a..8330563e41f2 100644 --- a/doc/man/salt-master.1 +++ b/doc/man/salt-master.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-MASTER" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-MASTER" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-master \- salt-master Documentation . diff --git a/doc/man/salt-minion.1 b/doc/man/salt-minion.1 index 104516d0db69..10f5960dbaa0 100644 --- a/doc/man/salt-minion.1 +++ b/doc/man/salt-minion.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-MINION" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-MINION" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-minion \- salt-minion Documentation . diff --git a/doc/man/salt-proxy.1 b/doc/man/salt-proxy.1 index 8819c07ad85f..230996cad3f3 100644 --- a/doc/man/salt-proxy.1 +++ b/doc/man/salt-proxy.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-PROXY" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-PROXY" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-proxy \- salt-proxy Documentation . diff --git a/doc/man/salt-run.1 b/doc/man/salt-run.1 index a91bcf72f6eb..e4007eb82b97 100644 --- a/doc/man/salt-run.1 +++ b/doc/man/salt-run.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-RUN" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-RUN" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-run \- salt-run Documentation . diff --git a/doc/man/salt-ssh.1 b/doc/man/salt-ssh.1 index cf9c27288528..bb3dccd840b2 100644 --- a/doc/man/salt-ssh.1 +++ b/doc/man/salt-ssh.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-SSH" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-SSH" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-ssh \- salt-ssh Documentation . diff --git a/doc/man/salt-syndic.1 b/doc/man/salt-syndic.1 index bad008d40bee..2a59817cd295 100644 --- a/doc/man/salt-syndic.1 +++ b/doc/man/salt-syndic.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-SYNDIC" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-SYNDIC" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-syndic \- salt-syndic Documentation . diff --git a/doc/man/salt-unity.1 b/doc/man/salt-unity.1 index 985dc4238f52..4144efd5d1a4 100644 --- a/doc/man/salt-unity.1 +++ b/doc/man/salt-unity.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-UNITY" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT-UNITY" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt-unity \- salt-unity Command . diff --git a/doc/man/salt.1 b/doc/man/salt.1 index b67604eae511..42114d0422c8 100644 --- a/doc/man/salt.1 +++ b/doc/man/salt.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME salt \- salt . diff --git a/doc/man/salt.7 b/doc/man/salt.7 index 141914fe6d5d..52c3fb92b838 100644 --- a/doc/man/salt.7 +++ b/doc/man/salt.7 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT" "7" "Feb 25, 2022" "3003.4" "Salt" +.TH "SALT" "7" "May 24, 2022" "3003.5" "Salt" .SH NAME salt \- Salt Documentation . @@ -90291,27 +90291,46 @@ watchdog Python module >= 0.8.3 .UNINDENT .INDENT 0.0 .TP -.B class salt.beacons.watchdog.FileSystemEventHandler -A dummy class to make the import work -.UNINDENT -.INDENT 0.0 -.TP .B class salt.beacons.watchdog.Handler(queue, masks=None) .INDENT 7.0 .TP .B on_created(event) +Called when a file or directory is created. +.INDENT 7.0 +.TP +.B Parameters +\fBevent\fP (\fBDirCreatedEvent\fP or \fBFileCreatedEvent\fP) \-\- Event representing file/directory creation. +.UNINDENT .UNINDENT .INDENT 7.0 .TP .B on_deleted(event) +Called when a file or directory is deleted. +.INDENT 7.0 +.TP +.B Parameters +\fBevent\fP (\fBDirDeletedEvent\fP or \fBFileDeletedEvent\fP) \-\- Event representing file/directory deletion. +.UNINDENT .UNINDENT .INDENT 7.0 .TP .B on_modified(event) +Called when a file or directory is modified. +.INDENT 7.0 +.TP +.B Parameters +\fBevent\fP (\fBDirModifiedEvent\fP or \fBFileModifiedEvent\fP) \-\- Event representing file/directory modification. +.UNINDENT .UNINDENT .INDENT 7.0 .TP .B on_moved(event) +Called when a file or a directory is moved or renamed. +.INDENT 7.0 +.TP +.B Parameters +\fBevent\fP (\fBDirMovedEvent\fP or \fBFileMovedEvent\fP) \-\- Event representing file/directory movement. +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -114982,7 +115001,7 @@ Introspect Ansible module. .INDENT 7.0 .TP .B Parameters -\fBmodule\fP \-\- +\fBmodule\fP \-\- .TP .B Returns @@ -115000,7 +115019,7 @@ Display help on Ansible standard module. .INDENT 7.0 .TP .B Parameters -\fBmodule\fP \-\- +\fBmodule\fP \-\- .TP .B Returns @@ -124515,7 +124534,7 @@ salt \(aq*\(aq bcache.cache_make sdb reserved=10% block_size=4096 .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBreserved\fP \-\- +\fBreserved\fP \-\- .sp if dev is a full device, create a partition table with this size empty. .sp @@ -127588,7 +127607,7 @@ the following characters: a\-z (lowercase), 0\-9, and \- (hyphen). \fBelasticsearch_version\fP (\fI\%str\fP) \-\- String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". .IP \(bu 2 -\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- +\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- .sp Dictionary specifying the configuration options for an Elasticsearch domain. Keys (case sensitive) in here are: @@ -127623,7 +127642,7 @@ active and on standby, for the cluster. .UNINDENT .IP \(bu 2 -\fBebs_options\fP (\fI\%dict\fP) \-\- +\fBebs_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the options to enable or disable and specifying the type and size of EBS storage volumes. @@ -127642,7 +127661,7 @@ Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). .IP \(bu 2 \fBaccess_policies\fP (\fI\%str\fP\fI or \fP\fI\%dict\fP) \-\- Dict or JSON string with the IAM access policy. .IP \(bu 2 -\fBsnapshot_options\fP (\fI\%dict\fP) \-\- +\fBsnapshot_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the snapshot options. Keys (case sensitive) in here are: @@ -127654,7 +127673,7 @@ Elasticsearch domain. Default value is 0 hours. .UNINDENT .IP \(bu 2 -\fBvpc_options\fP (\fI\%dict\fP) \-\- +\fBvpc_options\fP (\fI\%dict\fP) \-\- .sp Dict with the options to specify the subnets and security groups for the VPC endpoint. @@ -127667,7 +127686,7 @@ SecurityGroupIds (list): The list of security groups for the VPC endpoint. .UNINDENT .IP \(bu 2 -\fBcognito_options\fP (\fI\%dict\fP) \-\- +\fBcognito_options\fP (\fI\%dict\fP) \-\- .sp Dict with options to specify the cognito user and identity pools for Kibana authentication. @@ -127685,7 +127704,7 @@ for accessing Cognito resources. .UNINDENT .IP \(bu 2 -\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\- +\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the encryption at rest options. Keys (case sensitive) in here are: @@ -127697,7 +127716,7 @@ KmsKeyId (str): Specifies the KMS Key ID for Encryption At Rest options. .UNINDENT .IP \(bu 2 -\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\- +\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the node to node encryption options. Keys (case sensitive) in here are: @@ -127713,7 +127732,7 @@ sub\-resources. By default, the value is True. See \fI\%http://docs.aws.amazon.com/elasticsearch\-service/latest/developerguide\fP /es\-createupdatedomains.html#es\-createdomain\-configure\-advanced\-options for more information. .IP \(bu 2 -\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- +\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- .sp Dict with options for various type of logs. The keys denote the type of log file and can be one of the following: @@ -128291,7 +128310,7 @@ Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a\-z (lowercase), 0\-9, and \- (hyphen). .IP \(bu 2 -\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- +\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- .sp Dictionary specifying the configuration options for an Elasticsearch domain. Keys (case sensitive) in here are: @@ -128324,7 +128343,7 @@ active and on standby, for the cluster. .UNINDENT .IP \(bu 2 -\fBebs_options\fP (\fI\%dict\fP) \-\- +\fBebs_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the options to enable or disable and specifying the type and size of EBS storage volumes. @@ -128341,7 +128360,7 @@ Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). .UNINDENT .IP \(bu 2 -\fBsnapshot_options\fP (\fI\%dict\fP) \-\- +\fBsnapshot_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the snapshot options. Keys (case sensitive) in here are: @@ -128353,7 +128372,7 @@ Elasticsearch domain. Default value is 0 hours. .UNINDENT .IP \(bu 2 -\fBvpc_options\fP (\fI\%dict\fP) \-\- +\fBvpc_options\fP (\fI\%dict\fP) \-\- .sp Dict with the options to specify the subnets and security groups for the VPC endpoint. @@ -128366,7 +128385,7 @@ SecurityGroupIds (list): The list of security groups for the VPC endpoint. .UNINDENT .IP \(bu 2 -\fBcognito_options\fP (\fI\%dict\fP) \-\- +\fBcognito_options\fP (\fI\%dict\fP) \-\- .sp Dict with options to specify the cognito user and identity pools for Kibana authentication. @@ -128392,7 +128411,7 @@ for more information. .IP \(bu 2 \fBaccess_policies\fP (\fIstr/dict\fP) \-\- Dict or JSON string with the IAM access policy. .IP \(bu 2 -\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- +\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- .sp Dict with options for various type of logs. The keys denote the type of log file and can be one of the following: @@ -148120,7 +148139,7 @@ be a problem on Windows versions 2012/8 and later .IP \(bu 2 \fBforce\fP (\fI\%bool\fP) \-\- Run the bootstrap process even if Chocolatey is found in the path. .IP \(bu 2 -\fBsource\fP (\fI\%str\fP) \-\- +\fBsource\fP (\fI\%str\fP) \-\- .sp The location of the \fB\&.nupkg\fP file or \fB\&.ps1\fP file to run from an alternate location. This can be one of the following types of URLs: @@ -148243,7 +148262,7 @@ argument. Required. \fBversion\fP (\fI\%str\fP) \-\- Install a specific version of the package. Defaults to latest version. Default is None. .IP \(bu 2 -\fBsource\fP (\fI\%str\fP) \-\- +\fBsource\fP (\fI\%str\fP) \-\- .sp Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey feed. @@ -148281,7 +148300,7 @@ default arguments. Default is None. .IP \(bu 2 \fBpackage_args\fP (\fI\%str\fP) \-\- Arguments you want to pass to the package. Default is None. .IP \(bu 2 -\fBallow_multiple\fP (\fI\%bool\fP) \-\- +\fBallow_multiple\fP (\fI\%bool\fP) \-\- .sp Allow multiple versions of the package to be installed. Do not use with \fBforce\fP\&. Does not work with all packages. Default is False. @@ -148290,7 +148309,7 @@ New in version 2017.7.0. .IP \(bu 2 -\fBexecution_timeout\fP (\fI\%str\fP) \-\- +\fBexecution_timeout\fP (\fI\%str\fP) \-\- .sp Chocolatey execution timeout value you want to pass to the installation process. Default is None. @@ -148545,7 +148564,7 @@ None is passed. Default is None. .IP \(bu 2 \fBlocal_only\fP (\fI\%bool\fP) \-\- Display packages only installed locally. Default is False. .IP \(bu 2 -\fBexact\fP (\fI\%bool\fP) \-\- +\fBexact\fP (\fI\%bool\fP) \-\- .sp Display only packages that match \fBnarrow\fP exactly. Default is False. @@ -149666,7 +149685,7 @@ Note: CIMC Mounted vMedia is enabled through BIOS configuration. .IP \(bu 2 \fBremote_share\fP (\fI\%str\fP) \-\- The file share link that will be used to mount the share. This can be NFS, CIFS, or WWW. This .IP \(bu 2 -\fBbe the directory path and not the full path to the remote file.\fP (\fImust\fP) \-\- +\fBbe the directory path and not the full path to the remote file.\fP (\fImust\fP) \-\- .IP \(bu 2 \fBremote_file\fP (\fI\%str\fP) \-\- The name of the remote file to mount. It must reside within remote_share. .IP \(bu 2 @@ -149674,11 +149693,11 @@ Note: CIMC Mounted vMedia is enabled through BIOS configuration. .IP \(bu 2 \fBusername\fP (\fI\%str\fP) \-\- An optional requirement to pass credentials to the remote share. If not provided, an .IP \(bu 2 -\fBconnection attempt will be made.\fP (\fIunauthenticated\fP) \-\- +\fBconnection attempt will be made.\fP (\fIunauthenticated\fP) \-\- .IP \(bu 2 \fBpassword\fP (\fI\%str\fP) \-\- An optional requirement to pass a password to the remote share. If not provided, an .IP \(bu 2 -\fBconnection attempt will be made.\fP \-\- +\fBconnection attempt will be made.\fP \-\- .UNINDENT .UNINDENT .sp @@ -149818,7 +149837,7 @@ New in version 2019.2.0. .IP \(bu 2 \fBpolicy\fP (\fI\%str\fP) \-\- The action to be taken when chassis power is restored after .IP \(bu 2 -\fBunexpected power loss. This can be one of the following\fP (\fIan\fP) \-\- +\fBunexpected power loss. This can be one of the following\fP (\fIan\fP) \-\- .sp reset: The server is allowed to boot up normally when power is restored. The server can restart immediately or, optionally, after a @@ -149832,7 +149851,7 @@ any processes that were running before power was lost. .IP \(bu 2 \fBdelayType\fP (\fI\%str\fP) \-\- If the selected policy is reset, the restart can be .IP \(bu 2 -\fBwith this option. This can be one of the following\fP (\fIdelayed\fP) \-\- +\fBwith this option. This can be one of the following\fP (\fIdelayed\fP) \-\- .sp fixed: The server restarts after a fixed delay. .sp @@ -149841,11 +149860,11 @@ random: The server restarts after a random delay. .IP \(bu 2 \fBdelayValue\fP (\fI\%int\fP) \-\- If a fixed delay is selected, once chassis power is .IP \(bu 2 -\fBand the Cisco IMC has finished rebooting\fP\fB, \fP\fBthe system waits for\fP (\fIrestored\fP) \-\- +\fBand the Cisco IMC has finished rebooting\fP\fB, \fP\fBthe system waits for\fP (\fIrestored\fP) \-\- .IP \(bu 2 -\fBspecified number of seconds before restarting the server. Enter an\fP (\fIthe\fP) \-\- +\fBspecified number of seconds before restarting the server. Enter an\fP (\fIthe\fP) \-\- .IP \(bu 2 -\fBbetween 0 and 240.\fP (\fIinteger\fP) \-\- +\fBbetween 0 and 240.\fP (\fIinteger\fP) \-\- .UNINDENT .UNINDENT .sp @@ -151127,7 +151146,7 @@ behavior is to run as the user under which Salt is running. If running on a Windows minion you must also use the \fBpassword\fP argument, and the target user account must be in the Administrators group. .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -151143,7 +151162,7 @@ also use "pwsh" for powershell core if present on the system arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -151188,7 +151207,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -151211,7 +151230,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -151232,7 +151251,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -151258,7 +151277,7 @@ more interactively to the console and the logs. This is experimental. .IP \(bu 2 \fBsaltenv\fP (\fI\%str\fP) \-\- The salt environment to use. Default is \(aqbase\(aq .IP \(bu 2 -\fBdepth\fP (\fI\%int\fP) \-\- +\fBdepth\fP (\fI\%int\fP) \-\- .sp The number of levels of contained objects to be included. Default is 2. Values greater than 4 seem to greatly increase the time @@ -151462,7 +151481,7 @@ also use "pwsh" for powershell core if present on the system arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -151507,7 +151526,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -151530,7 +151549,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -151658,7 +151677,7 @@ salt \(aq*\(aq cmd.powershell_all "dir mydirectory" force_list=True .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.retcode(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.retcode(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, success_retcodes=None, **kwargs) Execute a shell command and return the command\(aqs return code. .INDENT 7.0 .TP @@ -151675,7 +151694,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -151704,7 +151723,7 @@ cmd.retcode \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuser .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -151723,7 +151742,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -151768,7 +151787,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -151791,7 +151810,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -151893,7 +151912,7 @@ salt \(aq*\(aq cmd.retcode "grep f" stdin=\(aqone\entwo\enthree\enfour\enfive\en .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, encoded_cmd=False, raise_err=False, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, encoded_cmd=False, raise_err=False, prepend_path=None, success_retcodes=None, **kwargs) Execute the passed command and return the output as a string .INDENT 7.0 .TP @@ -151910,7 +151929,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. @@ -151940,7 +151959,7 @@ cmd.run \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuser \fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported on Windows. .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -151956,7 +151975,7 @@ default shell. arguments. Set to \fBTrue\fP to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBbg\fP (\fI\%bool\fP) \-\- +\fBbg\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, run command in background and do not await or deliver its results @@ -151965,7 +151984,7 @@ New in version 2016.3.0. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -152001,7 +152020,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -152019,7 +152038,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -152042,7 +152061,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -152063,7 +152082,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -152085,7 +152104,7 @@ New in version 2018.3.0. \fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output more interactively to the console and the logs. This is experimental. .IP \(bu 2 -\fBencoded_cmd\fP (\fI\%bool\fP) \-\- +\fBencoded_cmd\fP (\fI\%bool\fP) \-\- .sp Specify if the supplied command is encoded. Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq. @@ -152250,7 +152269,7 @@ salt \(aq*\(aq cmd.run cmd=\(aqsed \-e s/=/:/g\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run_all(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, redirect_stderr=False, password=None, encoded_cmd=False, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run_all(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, redirect_stderr=False, password=None, encoded_cmd=False, prepend_path=None, success_retcodes=None, **kwargs) Execute the passed command and return a dict of return data .INDENT 7.0 .TP @@ -152267,7 +152286,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -152296,7 +152315,7 @@ cmd.run_all \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuser .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -152315,7 +152334,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -152351,7 +152370,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -152369,7 +152388,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -152392,7 +152411,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -152413,7 +152432,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -152436,7 +152455,7 @@ return. \fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output more interactively to the console and the logs. This is experimental. .IP \(bu 2 -\fBencoded_cmd\fP (\fI\%bool\fP) \-\- +\fBencoded_cmd\fP (\fI\%bool\fP) \-\- .sp Specify if the supplied command is encoded. Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq. @@ -152470,7 +152489,7 @@ Write\-Output $Encoded .UNINDENT .IP \(bu 2 -\fBredirect_stderr\fP (\fI\%bool\fP) \-\- +\fBredirect_stderr\fP (\fI\%bool\fP) \-\- .sp If set to \fBTrue\fP, then stderr will be redirected to stdout. This is helpful for cases where obtaining both @@ -152481,7 +152500,7 @@ New in version 2015.8.2. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -152493,7 +152512,7 @@ New in version 2016.3.0. .UNINDENT .IP \(bu 2 -\fBbg\fP (\fI\%bool\fP) \-\- +\fBbg\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, run command in background and do not await or deliver its results @@ -152569,7 +152588,7 @@ salt \(aq*\(aq cmd.run_all "grep f" stdin=\(aqone\entwo\enthree\enfour\enfive\en .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run_bg(cmd, cwd=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, timeout=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, password=None, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run_bg(cmd, cwd=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, timeout=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, password=None, prepend_path=None, success_retcodes=None, **kwargs) New in version 2016.3.0. .sp @@ -152602,7 +152621,7 @@ on Windows. \fBshell\fP (\fI\%str\fP) \-\- Shell to execute under. Defaults to the system default shell. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -152625,7 +152644,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -152646,7 +152665,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -152675,7 +152694,7 @@ cmd.run_bg \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuser .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -152691,7 +152710,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -152727,7 +152746,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -152846,7 +152865,7 @@ salt \(aq*\(aq cmd.run_bg cmd=\(aqls \-lR / | sed \-e s/=/:/g > /tmp/dontwait\(a .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run_chroot(root, cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=True, binds=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqquiet\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run_chroot(root, cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=True, binds=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqquiet\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, success_retcodes=None, **kwargs) New in version 2014.7.0. .sp @@ -152889,7 +152908,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBbinds\fP (\fI\%list\fP) \-\- +\fBbinds\fP (\fI\%list\fP) \-\- .sp List of directories that will be exported inside the chroot with the bind option. @@ -152898,7 +152917,7 @@ New in version 3000. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -152944,7 +152963,7 @@ before it is returned. \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -152967,7 +152986,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -152988,7 +153007,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -153045,7 +153064,7 @@ salt \(aq*\(aq cmd.run_chroot /var/lib/lxc/container_name/rootfs \(aqsh /tmp/boo .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run_stderr(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run_stderr(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) Execute a command and only return the standard error .INDENT 7.0 .TP @@ -153062,7 +153081,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -153091,7 +153110,7 @@ cmd.run_stderr \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuse .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -153110,7 +153129,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -153146,7 +153165,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -153164,7 +153183,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -153187,7 +153206,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -153208,7 +153227,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -153298,7 +153317,7 @@ salt \(aq*\(aq cmd.run_stderr "grep f" stdin=\(aqone\entwo\enthree\enfour\enfive .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.run_stdout(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.run_stdout(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) Execute a command, and only return the standard out .INDENT 7.0 .TP @@ -153315,7 +153334,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -153344,7 +153363,7 @@ cmd.run_stdout \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuse .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -153363,7 +153382,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -153399,7 +153418,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -153417,7 +153436,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -153440,7 +153459,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -153461,7 +153480,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -153551,7 +153570,7 @@ salt \(aq*\(aq cmd.run_stdout "grep f" stdin=\(aqone\entwo\enthree\enfour\enfive .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.script(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.script(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, template=None, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, success_retcodes=None, **kwargs) Download a script from a remote location and execute the script locally. The script can be located on the salt master file server or on an HTTP/FTP server. @@ -153567,7 +153586,7 @@ programming language. located on the master in the directory named spam, and is called eggs, the source string is salt://spam/eggs .IP \(bu 2 -\fBargs\fP (\fI\%str\fP) \-\- +\fBargs\fP (\fI\%str\fP) \-\- .sp String of command line args to pass to the script. Only used if no args are specified as part of the \fIname\fP argument. To pass a @@ -153592,7 +153611,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -153625,7 +153644,7 @@ More information <\fI\%https://github.com/saltstack/salt/issues/55080\fP> .UNINDENT .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -153647,7 +153666,7 @@ redirection. \fBbg\fP (\fI\%bool\fP) \-\- If True, run script in background and do not await or deliver its results .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -153685,7 +153704,7 @@ mako, and wempy are supported. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -153708,7 +153727,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -153729,7 +153748,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -153804,7 +153823,7 @@ salt \(aq*\(aq cmd.script salt://scripts/runme.sh stdin=\(aqone\entwo\enthree\en .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.script_retcode(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, template=\(aqjinja\(aq, umask=None, timeout=None, reset_system_locale=True, saltenv=\(aqbase\(aq, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, use_vt=False, password=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.script_retcode(source, args=None, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, python_shell=None, env=None, template=\(aqjinja\(aq, umask=None, timeout=None, reset_system_locale=True, saltenv=\(aqbase\(aq, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, use_vt=False, password=None, success_retcodes=None, **kwargs) Download a script from a remote location and execute the script locally. The script can be located on the salt master file server or on an HTTP/FTP server. @@ -153842,7 +153861,7 @@ behavior is to run as the user under which Salt is running. If running on a Windows minion you must also use the \fBpassword\fP argument, and the target user account must be in the Administrators group. .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -153861,7 +153880,7 @@ default shell. arguments. Set to True to use shell features, such as pipes or redirection. .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -153899,7 +153918,7 @@ mako, and wempy are supported. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -153922,7 +153941,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -154005,7 +154024,7 @@ salt \(aq*\(aq cmd.script_retcode salt://scripts/runme.sh stdin=\(aqone\entwo\en .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.shell(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.shell(cmd, cwd=None, stdin=None, runas=None, group=None, shell=\(aq/bin/zsh\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, bg=False, password=None, prepend_path=None, success_retcodes=None, **kwargs) Execute the passed command and return the output as a string. .sp New in version 2015.5.0. @@ -154025,7 +154044,7 @@ under which Salt is running if \fBrunas\fP is not specified). command to be run using the \fBstdin\fP parameter. This can be useful in cases where sensitive information must be read from standard input. .IP \(bu 2 -\fBrunas\fP (\fI\%str\fP) \-\- +\fBrunas\fP (\fI\%str\fP) \-\- .sp Specify an alternate user to run the command. The default behavior is to run as the user under which Salt is running. If running @@ -154057,7 +154076,7 @@ cmd.shell \(aqecho \(aq\e\(aq\(aqh=\e"baz\e"\(aq\e\(aq\(aq\(aq runas=macuser \fBgroup\fP (\fI\%str\fP) \-\- Group to run command as. Not currently supported on Windows. .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. @@ -154072,7 +154091,7 @@ shell. \fBbg\fP (\fI\%bool\fP) \-\- If True, run command in background and do not await or deliver its results .IP \(bu 2 -\fBenv\fP (\fI\%dict\fP) \-\- +\fBenv\fP (\fI\%dict\fP) \-\- .sp Environment variables to be set prior to execution. .sp @@ -154108,7 +154127,7 @@ systems. variables and set only those provided in the \(aqenv\(aq argument to this function. .IP \(bu 2 -\fBprepend_path\fP (\fI\%str\fP) \-\- +\fBprepend_path\fP (\fI\%str\fP) \-\- .sp $PATH segment to prepend (trailing \(aq:\(aq not necessary) to $PATH @@ -154126,7 +154145,7 @@ returned. .IP \(bu 2 \fBumask\fP (\fI\%str\fP) \-\- The umask (in octal) to use when running the command. .IP \(bu 2 -\fBoutput_encoding\fP (\fI\%str\fP) \-\- +\fBoutput_encoding\fP (\fI\%str\fP) \-\- .sp Control the encoding used to decode the command\(aqs output. @@ -154149,7 +154168,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBoutput_loglevel\fP (\fI\%str\fP) \-\- +\fBoutput_loglevel\fP (\fI\%str\fP) \-\- .sp Control the loglevel at which the output from the command is logged to the minion log. @@ -154170,7 +154189,7 @@ programs use the return code for signaling and a nonzero exit code doesn\(aqt necessarily mean failure. Pass this argument as \fBTrue\fP to skip logging the output if the command has a nonzero exit code. .IP \(bu 2 -\fBhide_output\fP (\fI\%bool\fP) \-\- +\fBhide_output\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, suppress stdout and stderr in the return data. @@ -154317,11 +154336,11 @@ languages all return the \fBinstalled\fP, \fBpath\fP, \fBversion\fP, .IP \(bu 2 \fBshell\fP (\fI\%str\fP) \-\- Name of the shell. Support shells/script languages include .IP \(bu 2 -\fBcmd\fP\fB, \fP\fBperl\fP\fB, \fP\fBphp\fP\fB, \fP\fBpowershell\fP\fB, \fP\fBpython\fP\fB, \fP\fBruby and zsh\fP (\fIbash\fP\fI,\fP) \-\- +\fBcmd\fP\fB, \fP\fBperl\fP\fB, \fP\fBphp\fP\fB, \fP\fBpowershell\fP\fB, \fP\fBpython\fP\fB, \fP\fBruby and zsh\fP (\fIbash\fP\fI,\fP) \-\- .IP \(bu 2 \fBlist_modules\fP (\fI\%bool\fP) \-\- True to list modules available to the shell. .IP \(bu 2 -\fBonly lists powershell modules.\fP (\fICurrently\fP) \-\- +\fBonly lists powershell modules.\fP (\fICurrently\fP) \-\- .UNINDENT .TP .B Returns @@ -188164,7 +188183,7 @@ pkg:apache .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp Specify an alternate delimiter to use when traversing a nested dict. This is useful for when the desired key contains a colon. See CLI @@ -188174,7 +188193,7 @@ New in version 2014.7.0. .IP \(bu 2 -\fBordered\fP \-\- +\fBordered\fP \-\- .sp Outputs an ordered dict if applicable (default: True) .sp @@ -188264,7 +188283,7 @@ Pillar values: .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlookup_dict\fP \-\- +\fBlookup_dict\fP \-\- .sp A dictionary, keyed by a grain, containing a value or values relevant to systems matching that grain. For example, a key @@ -188288,7 +188307,7 @@ salt \(aq*\(aq grains.filter_by \(aq{salt*: got some salt, default: salt is not .IP \(bu 2 -\fBgrain\fP \-\- +\fBgrain\fP \-\- .sp The name of a grain to match with the current system\(aqs grains. For example, the value of the "os_family" grain for the current @@ -188308,7 +188327,7 @@ values for non\-standard package names such as when using a different Python version from the default Python version provided by the OS (e.g., \fBpython26\-mysql\fP instead of \fBpython\-mysql\fP). .IP \(bu 2 -\fBdefault\fP \-\- +\fBdefault\fP \-\- .sp default lookup_dict\(aqs key used if the grain does not exists or if the grain value has no match on lookup_dict. If unspecified @@ -188318,7 +188337,7 @@ New in version 2014.1.0. .IP \(bu 2 -\fBbase\fP \-\- +\fBbase\fP \-\- .sp A lookup_dict key to use for a base dictionary. The grain\-selected \fBlookup_dict\fP is merged over this and then finally @@ -188385,7 +188404,7 @@ pkg:apache .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdelimiter\fP \-\- +\fBdelimiter\fP \-\- .sp Specify an alternate delimiter to use when traversing a nested dict. This is useful for when the desired key contains a colon. See CLI @@ -188395,7 +188414,7 @@ New in version 2014.7.0. .IP \(bu 2 -\fBordered\fP \-\- +\fBordered\fP \-\- .sp Outputs an ordered dict if applicable (default: True) .sp @@ -192336,7 +192355,7 @@ Passes through all the parameters described in the \fI\%utils.http.query function\fP: .INDENT 7.0 .TP -.B salt.utils.http.query(url, method=\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=\(aqSalt/3003.4\(aq, hide_fields=None, raise_error=True, formdata=False, formdata_fieldname=None, formdata_filename=None, decode_body=True, **kwargs) +.B salt.utils.http.query(url, method=\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=\(aqSalt/3003.5\(aq, hide_fields=None, raise_error=True, formdata=False, formdata_fieldname=None, formdata_filename=None, decode_body=True, **kwargs) Query a resource, and decode the return data .UNINDENT .INDENT 7.0 @@ -195321,9 +195340,9 @@ Build an image using Kiwi. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBformat\fP \-\- +\fBformat\fP \-\- .IP \(bu 2 -\fBpath\fP \-\- +\fBpath\fP \-\- .UNINDENT .TP .B Returns @@ -195349,9 +195368,9 @@ Export description for Kiwi. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlocal\fP \-\- +\fBlocal\fP \-\- .IP \(bu 2 -\fBpath\fP \-\- +\fBpath\fP \-\- .UNINDENT .TP .B Returns @@ -195536,7 +195555,7 @@ NOTE: This method doesn\(aqt stores anything. .INDENT 7.0 .TP .B Parameters -\fBobj\fP \-\- +\fBobj\fP \-\- .TP .B Returns @@ -195551,15 +195570,15 @@ Delete object from the database. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBobj\fP \-\- +\fBobj\fP \-\- .IP \(bu 2 -\fBmatches\fP \-\- +\fBmatches\fP \-\- .IP \(bu 2 -\fBmt\fP \-\- +\fBmt\fP \-\- .IP \(bu 2 -\fBlt\fP \-\- +\fBlt\fP \-\- .IP \(bu 2 -\fBeq\fP \-\- +\fBeq\fP \-\- .UNINDENT .TP .B Returns @@ -195573,7 +195592,7 @@ Flush table. .INDENT 7.0 .TP .B Parameters -\fBtable\fP \-\- +\fBtable\fP \-\- .TP .B Returns @@ -195588,7 +195607,7 @@ Get objects from the table. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtable_name\fP \-\- +\fBtable_name\fP \-\- .IP \(bu 2 \fBmatches\fP \-\- Regexp. .IP \(bu 2 @@ -195661,7 +195680,7 @@ Purge the database. .INDENT 7.0 .TP .B Parameters -\fBdbid\fP \-\- +\fBdbid\fP \-\- .TP .B Returns @@ -195695,15 +195714,15 @@ Update object(s) in the database. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBobj\fP \-\- +\fBobj\fP \-\- .IP \(bu 2 -\fBmatches\fP \-\- +\fBmatches\fP \-\- .IP \(bu 2 -\fBmt\fP \-\- +\fBmt\fP \-\- .IP \(bu 2 -\fBlt\fP \-\- +\fBlt\fP \-\- .IP \(bu 2 -\fBeq\fP \-\- +\fBeq\fP \-\- .UNINDENT .TP .B Returns @@ -195738,7 +195757,7 @@ Load data by keys. .INDENT 7.0 .TP .B Parameters -\fBdata\fP \-\- +\fBdata\fP \-\- .TP .B Returns @@ -197168,7 +197187,7 @@ Set channel access .UNINDENT .IP \(bu 2 -\fBalerting\fP \-\- +\fBalerting\fP \-\- .sp PEF Alerting Enable/Disable .INDENT 2.0 @@ -197180,7 +197199,7 @@ False = disable PEF Alerting on this channel .UNINDENT .IP \(bu 2 -\fBper_msg_auth\fP \-\- +\fBper_msg_auth\fP \-\- .sp Per\-message Authentication .INDENT 2.0 @@ -197193,7 +197212,7 @@ used on subsequent packets for the session.] .UNINDENT .IP \(bu 2 -\fBuser_level_auth\fP \-\- +\fBuser_level_auth\fP \-\- .sp User Level Authentication Enable/Disable .INDENT 2.0 @@ -197212,7 +197231,7 @@ Authentication Type that was used for the request. .UNINDENT .IP \(bu 2 -\fBaccess_mode\fP \-\- +\fBaccess_mode\fP \-\- .sp Access Mode for IPMI messaging (PEF Alerting is enabled/disabled separately from IPMI messaging) @@ -197231,7 +197250,7 @@ serial port available for software use. .UNINDENT .IP \(bu 2 -\fBprivilege_update_mode\fP \-\- +\fBprivilege_update_mode\fP \-\- .sp Channel Privilege Level Limit. This value sets the maximum privilege level that can be accepted on the specified channel. @@ -197245,7 +197264,7 @@ volatile = volatile setting of Privilege Level Limit .UNINDENT .IP \(bu 2 -\fBprivilege_level\fP \-\- +\fBprivilege_level\fP \-\- .sp Channel Privilege Level Limit .INDENT 2.0 @@ -197409,7 +197428,7 @@ Set user access .IP \(bu 2 \fBchannel\fP \-\- number [1:7] .IP \(bu 2 -\fBcallback\fP \-\- +\fBcallback\fP \-\- .sp User Restricted to Callback .INDENT 2.0 @@ -197443,7 +197462,7 @@ management, such as Get SOL Configuration Parameters and Close Session are available, but generic IPMI commands such as Get SEL Time are unavailable.) .IP \(bu 2 -\fBprivilege_level\fP \-\- +\fBprivilege_level\fP \-\- .sp User Privilege Limit. (Determines the maximum privilege level that the user is allowed to switch to on the specified channel.) @@ -205953,7 +205972,7 @@ Connect and optionally bind to an LDAP server. .INDENT 7.0 .TP .B Parameters -\fBconnect_spec\fP \-\- +\fBconnect_spec\fP \-\- .sp This can be an LDAP connection object returned by a previous call to \fI\%connect()\fP (in which case the argument is @@ -206247,7 +206266,7 @@ Modify an entry in an LDAP database. .IP \(bu 2 \fBdn\fP \-\- Distinguished name of the entry. .IP \(bu 2 -\fBdirectives\fP \-\- +\fBdirectives\fP \-\- .sp Iterable of directives that indicate how to modify the entry. Each directive is a tuple of the form \fB(op, attr, vals)\fP, @@ -206312,7 +206331,7 @@ Search an LDAP database. .IP \(bu 2 \fBbase\fP \-\- Distinguished name of the entry at which to start the search. .IP \(bu 2 -\fBscope\fP \-\- +\fBscope\fP \-\- .sp One of the following: .INDENT 2.0 @@ -220007,7 +220026,7 @@ Halt a running system .INDENT 7.0 .TP .B Parameters -\fBat_time\fP (\fI\%str\fP) \-\- +\fBat_time\fP (\fI\%str\fP) \-\- .sp Any valid \fIat\fP expression. For example, some valid at expressions could be: @@ -220081,7 +220100,7 @@ Restart the system .INDENT 7.0 .TP .B Parameters -\fBat_time\fP (\fI\%str\fP) \-\- +\fBat_time\fP (\fI\%str\fP) \-\- .sp Any valid \fIat\fP expression. For example, some valid at expressions could be: @@ -220140,7 +220159,7 @@ result of system files being locked down in macOS (SIP Protection). .INDENT 7.0 .TP .B Parameters -\fBarch\fP (\fI\%str\fP) \-\- +\fBarch\fP (\fI\%str\fP) \-\- .sp A string representing the desired architecture. If no value is passed, default is assumed. Valid values include: @@ -220411,7 +220430,7 @@ Shutdown the system .INDENT 7.0 .TP .B Parameters -\fBat_time\fP (\fI\%str\fP) \-\- +\fBat_time\fP (\fI\%str\fP) \-\- .sp Any valid \fIat\fP expression. For example, some valid at expressions could be: @@ -220461,7 +220480,7 @@ sleep. .INDENT 7.0 .TP .B Parameters -\fBat_time\fP (\fI\%str\fP) \-\- +\fBat_time\fP (\fI\%str\fP) \-\- .sp Any valid \fIat\fP expression. For example, some valid at expressions could be: @@ -220737,7 +220756,7 @@ Set the current month, day, and year .INDENT 7.0 .TP .B Parameters -\fBdate\fP (\fI\%str\fP) \-\- +\fBdate\fP (\fI\%str\fP) \-\- .sp The date to set. Valid date formats are: .INDENT 7.0 @@ -221162,7 +221181,7 @@ Configures the machine to auto login with the specified user .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The user account use for auto login .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp The password to user for auto login .sp @@ -224432,7 +224451,7 @@ This function accepts the following arguments: Specifies whether updating will clear the existing values (\fBTrue\fP), or whether it will update them (\fBFalse\fP). .IP \(bu 2 -\fBmine_functions\fP (\fI\%dict\fP) \-\- +\fBmine_functions\fP (\fI\%dict\fP) \-\- .sp Update (or clear, see \fBclear\fP) the mine data on these functions only. This will need to have the structure as defined on @@ -241217,7 +241236,7 @@ default: group5 (Optional) .IP \(bu 2 \fBprofile\fP \-\- Profile to build on (Optional) .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .UNINDENT .TP .B Returns @@ -243177,7 +243196,7 @@ default: true (Optional) .IP \(bu 2 \fBprofile\fP \-\- Profile to build on (Optional) .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .UNINDENT .TP .B Returns @@ -250098,7 +250117,7 @@ New in version 2017.7.0. \fBnames\fP \-\- Names of the packages to get information about. If none are specified, will return information for all installed packages. .IP \(bu 2 -\fBattr\fP \-\- +\fBattr\fP \-\- .sp Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned. .INDENT 2.0 @@ -255296,7 +255315,7 @@ delete the derived snapshots .IP \(bu 2 \fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as .IP \(bu 2 -\fBall\fP (\fI\%bool\fP) \-\- +\fBall\fP (\fI\%bool\fP) \-\- .sp Delete all snapshots having the name given .sp @@ -255425,7 +255444,7 @@ List information about the VMs .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp Name/ID of VM to list .sp @@ -255441,7 +255460,7 @@ Changed in version 2016.11.0: No longer implies \fBinfo=True\fP .IP \(bu 2 \fBrunas\fP (\fI\%str\fP) \-\- The user that the prlctl command will be run as .IP \(bu 2 -\fBtemplate\fP (\fI\%bool\fP) \-\- +\fBtemplate\fP (\fI\%bool\fP) \-\- .sp List the available virtual machine templates. The real virtual machines will not be included in the output @@ -257919,7 +257938,7 @@ Look up the given pillar in a given dictionary and return the result .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlookup_dict\fP \-\- +\fBlookup_dict\fP \-\- .sp A dictionary, keyed by a pillar, containing a value or values relevant to systems matching that pillar. For example, a key @@ -257942,7 +257961,7 @@ salt \(aq*\(aq pillar.filter_by \(aq{salt*: got some salt, default: salt is not .UNINDENT .IP \(bu 2 -\fBpillar\fP \-\- +\fBpillar\fP \-\- .sp The name of a pillar to match with the system\(aqs pillar. For example, the value of the "role" pillar could be used to pull values @@ -270981,7 +271000,7 @@ Delete a registry key to include all subkeys and value/data pairs. .INDENT 7.0 .TP .B Parameters -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following .INDENT 7.0 @@ -271050,7 +271069,7 @@ Delete a registry value entry or the default value for a key. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following .INDENT 2.0 @@ -271204,7 +271223,7 @@ Enumerates the subkeys in a registry key or hive. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following: .INDENT 2.0 @@ -271272,7 +271291,7 @@ will not be returned in the list of values. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following: .INDENT 2.0 @@ -271333,7 +271352,7 @@ default value, don\(aqt pass \fBvname\fP .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following: .INDENT 2.0 @@ -271429,7 +271448,7 @@ specified key .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhive\fP (\fI\%str\fP) \-\- +\fBhive\fP (\fI\%str\fP) \-\- .sp The name of the hive. Can be one of the following .INDENT 2.0 @@ -271455,7 +271474,7 @@ HKEY_CURRENT_CONFIG or HKCC \fBvname\fP (\fI\%str\fP) \-\- The value name. These are the individual name/data pairs under the key. If not passed, the key (Default) value will be set. .IP \(bu 2 -\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\- +\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\- .sp The value you\(aqd like to set. If a value name (vname) is passed, this will be the data for that value name. If not, this will be the @@ -272853,9 +272872,9 @@ If no packages specified, all packages will be returned. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpackages\fP \-\- +\fBpackages\fP \-\- .IP \(bu 2 -\fBattr\fP \-\- +\fBattr\fP \-\- .sp Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned. .INDENT 2.0 @@ -275519,7 +275538,7 @@ Execute one saltcheck test and return result .INDENT 7.0 .TP .B Parameters -\fBarg test\fP (\fIkeyword\fP) \-\- +\fBarg test\fP (\fIkeyword\fP) \-\- .UNINDENT .sp CLI Example: @@ -292405,7 +292424,7 @@ Set the system date. Use format for the date. .INDENT 7.0 .TP .B Parameters -\fBnewdate\fP (\fI\%str\fP) \-\- +\fBnewdate\fP (\fI\%str\fP) \-\- .sp The date to set. Can be any of the following formats: .INDENT 7.0 @@ -292500,7 +292519,7 @@ Set the system time. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnewtime\fP (\fI\%str\fP) \-\- +\fBnewtime\fP (\fI\%str\fP) \-\- .sp The time to set. Can be any of the following formats. \- HH:MM:SS AM/PM @@ -299199,7 +299218,7 @@ Return the value of key at path in vault, or entire secret .INDENT 7.0 .TP .B Parameters -\fBmetadata\fP \-\- +\fBmetadata\fP \-\- .sp Optional \- If using KV v2 backend, display full results, including metadata .sp @@ -300263,7 +300282,7 @@ New in version 2016.3.0. .IP \(bu 2 \fBout\fP \-\- \(aqlibvirt\(aq (default) for usable libvirt XML definition, \(aqsalt\(aq for nice dict .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300271,7 +300290,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300279,7 +300298,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300312,7 +300331,7 @@ Start a transient domain based on the XML\-file path passed to the function .IP \(bu 2 \fBpath\fP \-\- path to a file containing the libvirt XML definition of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300320,7 +300339,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300328,7 +300347,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300361,7 +300380,7 @@ Start a transient domain based on the XML passed to the function .IP \(bu 2 \fBxml\fP \-\- libvirt XML definition of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300369,7 +300388,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300377,7 +300396,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300410,7 +300429,7 @@ Sends CTRL+ALT+DEL to a VM .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300418,7 +300437,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300426,7 +300445,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300459,7 +300478,7 @@ Define a volume based on the XML\-file path passed to the function .IP \(bu 2 \fBpath\fP \-\- path to a file containing the libvirt XML definition of the volume .IP \(bu 2 -\fBpool\fP \-\- +\fBpool\fP \-\- .sp storage pool name to define the volume in. If defined, this parameter will override the configuration setting. @@ -300468,7 +300487,7 @@ New in version 3001. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300476,7 +300495,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300484,7 +300503,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300517,7 +300536,7 @@ Define a volume based on the XML passed to the function .IP \(bu 2 \fBxml\fP \-\- libvirt XML definition of the storage volume .IP \(bu 2 -\fBpool\fP \-\- +\fBpool\fP \-\- .sp storage pool name to define the volume in. If defined, this parameter will override the configuration setting. @@ -300526,7 +300545,7 @@ New in version 3001. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300534,7 +300553,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300542,7 +300561,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300589,7 +300608,7 @@ Define a persistent domain based on the XML\-file path passed to the function .IP \(bu 2 \fBpath\fP \-\- path to a file containing the libvirt XML definition of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300597,7 +300616,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300605,7 +300624,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300638,7 +300657,7 @@ Define a persistent domain based on the XML passed to the function .IP \(bu 2 \fBxml\fP \-\- libvirt XML definition of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300646,7 +300665,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300654,7 +300673,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300689,7 +300708,7 @@ Delete one or more snapshots of the given VM. .IP \(bu 2 \fBnames\fP \-\- names of the snapshots to remove .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300697,7 +300716,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300705,7 +300724,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300787,7 +300806,7 @@ hypervisor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300795,7 +300814,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300803,7 +300822,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300835,7 +300854,7 @@ been given to virtual machines on this node .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300843,7 +300862,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300851,7 +300870,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300882,7 +300901,7 @@ Return the node_info, vm_info and freemem .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300890,7 +300909,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300898,7 +300917,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300931,7 +300950,7 @@ Return the disks of a named vm .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300939,7 +300958,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300947,7 +300966,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -300980,7 +300999,7 @@ Returns the information on vnc for a given vm .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -300988,7 +301007,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -300996,7 +301015,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301093,7 +301112,7 @@ Return a list off MAC addresses from the named vm .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -301101,7 +301120,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -301109,7 +301128,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301142,7 +301161,7 @@ Return info about the network interfaces of a named vm .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -301150,7 +301169,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -301158,7 +301177,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301199,7 +301218,7 @@ disk .IP \(bu 2 \fBhypervisor\fP \-\- override the default machine type. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -301207,7 +301226,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -301215,7 +301234,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301249,7 +301268,7 @@ Returns the XML for a given vm .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -301257,7 +301276,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -301265,7 +301284,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301298,7 +301317,7 @@ Initialize a new vm .IP \(bu 2 \fBname\fP \-\- name of the virtual machine to create .IP \(bu 2 -\fBcpu\fP \-\- +\fBcpu\fP \-\- .sp Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is @@ -301421,7 +301440,7 @@ New in version 3003. .IP \(bu 2 -\fBmem\fP \-\- +\fBmem\fP \-\- .sp Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP, @@ -301464,7 +301483,7 @@ Changed in version 3002. The profile interfaces can be customized / extended with the interfaces parameter. If set to \fBNone\fP, no profile will be used. .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp List of dictionaries providing details on the network interfaces to create. These data are merged with the ones from the nic profile. The structure of @@ -301481,7 +301500,7 @@ to the virtual host capabilities. .IP \(bu 2 \fBdisk\fP \-\- Disk profile to use (Default: \fB\(aqdefault\(aq\fP). If set to \fBNone\fP, no profile will be used. .IP \(bu 2 -\fBdisks\fP \-\- +\fBdisks\fP \-\- .sp List of dictionaries providing details on the disk devices to create. These data are merged with the ones from the disk profile. The structure of @@ -301505,7 +301524,7 @@ See \fBcp module for more details\fP .IP \(bu 2 \fBseed_cmd\fP \-\- Salt command to execute to seed the image. (Default: \fB\(aqseed.apply\(aq\fP) .IP \(bu 2 -\fBgraphics\fP \-\- +\fBgraphics\fP \-\- .sp Dictionary providing details on the graphics device to create. (Default: \fBNone\fP) See \fI\%Graphics Definition\fP for more details on the possible values. @@ -301514,7 +301533,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBos_type\fP \-\- +\fBos_type\fP \-\- .sp type of virtualization as found in the \fB//os/type\fP element of the libvirt definition. The default value is taken from the host capabilities, with a preference for \fBhvm\fP\&. @@ -301523,7 +301542,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBarch\fP \-\- +\fBarch\fP \-\- .sp architecture of the virtual machine. The default value is taken from the host capabilities, but \fBx86_64\fP is prefed over \fBi686\fP\&. @@ -301543,7 +301562,7 @@ See \fBseed module for more details\fP .IP \(bu 2 \fBconsole\fP \-\- \fBTrue\fP to add a console device along with serial one (Default: \fBTrue\fP) .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -301551,7 +301570,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -301559,7 +301578,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -301567,7 +301586,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBstop_on_reboot\fP \-\- +\fBstop_on_reboot\fP \-\- .sp If set to \fBTrue\fP the guest will stop instead of rebooting. This is specially useful when creating a virtual machine with an installation cdrom or @@ -301578,7 +301597,7 @@ New in version 3003. .IP \(bu 2 -\fBboot\fP \-\- +\fBboot\fP \-\- .sp Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine. This is an optional parameter, all of the keys are optional within the dictionary. The structure of @@ -301607,7 +301626,7 @@ New in version 3000. .UNINDENT .IP \(bu 2 -\fBboot_dev\fP \-\- +\fBboot_dev\fP \-\- .sp Space separated list of devices to boot from sorted by decreasing priority. Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&. @@ -301615,7 +301634,7 @@ Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&. By default, the value will \fB"hd"\fP\&. .IP \(bu 2 -\fBnumatune\fP \-\- +\fBnumatune\fP \-\- .sp The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process @@ -301639,7 +301658,7 @@ New in version 3003. .UNINDENT .IP \(bu 2 -\fBhypervisor_features\fP \-\- +\fBhypervisor_features\fP \-\- .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp @@ -301658,7 +301677,7 @@ hypervisor_features: .UNINDENT .IP \(bu 2 -\fBclock\fP \-\- +\fBclock\fP \-\- .sp Configure the guest clock. The value is a dictionary with the following keys: @@ -301734,7 +301753,7 @@ clock: .UNINDENT .IP \(bu 2 -\fBserials\fP \-\- +\fBserials\fP \-\- .sp Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. @@ -301743,7 +301762,7 @@ New in version 3003. .IP \(bu 2 -\fBconsoles\fP \-\- +\fBconsoles\fP \-\- .sp Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. @@ -301752,7 +301771,7 @@ New in version 3003. .IP \(bu 2 -\fBhost_devices\fP \-\- +\fBhost_devices\fP \-\- .sp List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fI\%node_devices()\fP function. @@ -302251,7 +302270,7 @@ Return a list of names for active virtual machine on the minion .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -302259,7 +302278,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -302267,7 +302286,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -302298,7 +302317,7 @@ Return a list of available domains. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -302306,7 +302325,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -302314,7 +302333,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -302345,7 +302364,7 @@ Return a list of names for inactive virtual machine on the minion .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -302353,7 +302372,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -302361,7 +302380,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -302458,7 +302477,7 @@ List available snapshots for certain vm or for all. .IP \(bu 2 \fBdomain\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -302466,7 +302485,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -302474,7 +302493,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -302513,7 +302532,7 @@ Shared storage migration .IP \(bu 2 \fBtarget\fP \-\- target libvirt URI or host name .IP \(bu 2 -\fBssh\fP \-\- +\fBssh\fP \-\- .sp True to connect over ssh .sp @@ -302646,7 +302665,7 @@ Attempt to execute non\-shared storage "all" migration .IP \(bu 2 \fBtarget\fP \-\- target libvirt host name .IP \(bu 2 -\fBssh\fP \-\- +\fBssh\fP \-\- .sp True to connect over ssh .sp @@ -302770,7 +302789,7 @@ Attempt to execute non\-shared storage "inc" migration .IP \(bu 2 \fBtarget\fP \-\- target libvirt host name .IP \(bu 2 -\fBssh\fP \-\- +\fBssh\fP \-\- .sp True to connect over ssh .sp @@ -302918,7 +302937,7 @@ Create libvirt network. .IP \(bu 2 \fBbridge\fP \-\- Bridge name. .IP \(bu 2 -\fBforward\fP \-\- +\fBforward\fP \-\- .sp Forward mode (bridge, router, nat). .sp @@ -302926,7 +302945,7 @@ Changed in version 3003: a \fBNone\fP value creates an isolated network with no .IP \(bu 2 -\fBvport\fP \-\- +\fBvport\fP \-\- .sp Virtualport type. The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys. @@ -302949,7 +302968,7 @@ Changed in version 3003: possible dictionary value .IP \(bu 2 -\fBtag\fP \-\- +\fBtag\fP \-\- .sp Vlan tag. The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys. @@ -302980,7 +302999,7 @@ Changed in version 3003: possible dictionary value .IP \(bu 2 \fBstart\fP \-\- Network start (default True). .IP \(bu 2 -\fBipv4_config\fP (\fI\%dict\fP\fI or \fP\fI\%None\fP) \-\- +\fBipv4_config\fP (\fI\%dict\fP\fI or \fP\fI\%None\fP) \-\- .sp IP v4 configuration. Dictionary describing the IP v4 setup like IP range and @@ -302991,7 +303010,7 @@ New in version 3000. .IP \(bu 2 -\fBipv6_config\fP (\fI\%dict\fP\fI or \fP\fI\%None\fP) \-\- +\fBipv6_config\fP (\fI\%dict\fP\fI or \fP\fI\%None\fP) \-\- .sp IP v6 configuration. Dictionary describing the IP v6 setup like IP range and @@ -303008,7 +303027,7 @@ New in version 3000. .IP \(bu 2 \fBpassword\fP \-\- password to connect with, overriding defaults. .IP \(bu 2 -\fBmtu\fP \-\- +\fBmtu\fP \-\- .sp size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) @@ -303017,7 +303036,7 @@ New in version 3003. .IP \(bu 2 -\fBdomain\fP \-\- +\fBdomain\fP \-\- .sp DNS domain name of the DHCP server. The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one. @@ -303039,7 +303058,7 @@ New in version 3003. .IP \(bu 2 -\fBnat\fP \-\- +\fBnat\fP \-\- .sp addresses and ports to route in NAT forward mode. The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&. @@ -303067,7 +303086,7 @@ New in version 3003. .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp whitespace separated list of network interfaces devices that can be used for this network. (default \fBNone\fP) @@ -303087,7 +303106,7 @@ New in version 3003. .IP \(bu 2 -\fBaddresses\fP \-\- +\fBaddresses\fP \-\- .sp whitespace separated list of addreses of PCI devices that can be used for this network in \fIhostdev\fP forward mode. (default \fBNone\fP) @@ -303107,7 +303126,7 @@ New in version 3003. .IP \(bu 2 -\fBphysical_function\fP \-\- +\fBphysical_function\fP \-\- .sp device name of the physical interface to use in \fBhostdev\fP forward mode. (default \fBNone\fP) @@ -303127,7 +303146,7 @@ New in version 3003. .IP \(bu 2 -\fBdns\fP \-\- +\fBdns\fP \-\- .sp virtual network DNS configuration. The value is a dictionary described in \fI\%net\-define\-dns\fP\&. @@ -303465,7 +303484,7 @@ Update a virtual network if needed. \fBforward\fP \-\- Forward mode (bridge, router, nat). A \fBNone\fP value creates an isolated network with no forwarding at all. .IP \(bu 2 -\fBvport\fP \-\- +\fBvport\fP \-\- .sp Virtualport type. The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys. @@ -303485,7 +303504,7 @@ The \fBparameters\fP value is a dictionary of virtual port parameters. .UNINDENT .IP \(bu 2 -\fBtag\fP \-\- +\fBtag\fP \-\- .sp Vlan tag. The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys. @@ -303528,7 +303547,7 @@ in \fI\%net\-define\-ip\fP\&. \fBmtu\fP \-\- size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) .IP \(bu 2 -\fBdomain\fP \-\- +\fBdomain\fP \-\- .sp DNS domain name of the DHCP server. The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one. @@ -303547,7 +303566,7 @@ The value is a dictionary with a mandatory \fBname\fP property and an optional \ .UNINDENT .IP \(bu 2 -\fBnat\fP \-\- +\fBnat\fP \-\- .sp addresses and ports to route in NAT forward mode. The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&. @@ -303572,7 +303591,7 @@ Both values are a dictionary with \fBstart\fP and \fBend\fP values. .UNINDENT .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp whitespace separated list of network interfaces devices that can be used for this network. (default \fBNone\fP) @@ -303589,7 +303608,7 @@ whitespace separated list of network interfaces devices that can be used for thi .UNINDENT .IP \(bu 2 -\fBaddresses\fP \-\- +\fBaddresses\fP \-\- .sp whitespace separated list of addreses of PCI devices that can be used for this network in \fIhostdev\fP forward mode. (default \fBNone\fP) @@ -303606,7 +303625,7 @@ whitespace separated list of addreses of PCI devices that can be used for this n .UNINDENT .IP \(bu 2 -\fBphysical_function\fP \-\- +\fBphysical_function\fP \-\- .sp device name of the physical interface to use in \fBhostdev\fP forward mode. (default \fBNone\fP) @@ -303623,7 +303642,7 @@ device name of the physical interface to use in \fBhostdev\fP forward mode. .UNINDENT .IP \(bu 2 -\fBdns\fP \-\- +\fBdns\fP \-\- .sp virtual network DNS configuration. The value is a dictionary described in \fI\%net\-define\-dns\fP\&. @@ -303694,7 +303713,7 @@ Return a dict with information about this node .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -303702,7 +303721,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -303710,7 +303729,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -303743,7 +303762,7 @@ Pause the named vm .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -303751,7 +303770,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -303759,7 +303778,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -303870,7 +303889,7 @@ possible values. \fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based pool types. See \fI\%Permissions definition\fP for more details on this structure. .IP \(bu 2 -\fBsource_devices\fP \-\- +\fBsource_devices\fP \-\- .sp List of source devices for pools backed by physical devices. (Default: \fBNone\fP) .sp @@ -303884,7 +303903,7 @@ for more information on the use of \fBpart_separator\fP \fBsource_dir\fP \-\- Path to the source directory for pools of type \fBdir\fP, \fBnetfs\fP or \fBgluster\fP\&. (Default: \fBNone\fP) .IP \(bu 2 -\fBsource_initiator\fP \-\- +\fBsource_initiator\fP \-\- .sp Initiator IQN for libiscsi\-direct pool types. (Default: \fBNone\fP) .sp @@ -303892,7 +303911,7 @@ New in version 3000. .IP \(bu 2 -\fBsource_adapter\fP \-\- +\fBsource_adapter\fP \-\- .sp SCSI source definition. The value is a dictionary with \fBtype\fP, \fBname\fP, \fBparent\fP, \fBmanaged\fP, \fBparent_wwnn\fP, \fBparent_wwpn\fP, \fBparent_fabric_wwn\fP, \fBwwnn\fP, \fBwwpn\fP @@ -303908,7 +303927,7 @@ for the meaning and possible values of these properties. \fBsource_hosts\fP \-\- List of source for pools backed by storage from remote servers. Each item is the hostname optionally followed by the port separated by a colon. (Default: \fBNone\fP) .IP \(bu 2 -\fBsource_auth\fP \-\- +\fBsource_auth\fP \-\- .sp Source authentication details. (Default: \fBNone\fP) .sp @@ -303961,7 +303980,7 @@ For Ceph authentications a base64 encoded key is expected. .IP \(bu 2 \fBsource_name\fP \-\- Identifier of name\-based sources. .IP \(bu 2 -\fBsource_format\fP \-\- +\fBsource_format\fP \-\- .sp String representing the source format. The possible values are depending on the source type. See \fI\%libvirt documentation\fP for @@ -304352,7 +304371,7 @@ If called with test=True, this is also reporting whether an update would be perf .IP \(bu 2 \fBname\fP \-\- Pool name .IP \(bu 2 -\fBptype\fP \-\- +\fBptype\fP \-\- .sp Pool type. See \fI\%libvirt documentation\fP for the possible values. @@ -304363,7 +304382,7 @@ possible values. \fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based pool types. See \fI\%Permissions definition\fP for more details on this structure. .IP \(bu 2 -\fBsource_devices\fP \-\- +\fBsource_devices\fP \-\- .sp List of source devices for pools backed by physical devices. (Default: \fBNone\fP) .sp @@ -304377,7 +304396,7 @@ for more information on the use of \fBpart_separator\fP \fBsource_dir\fP \-\- Path to the source directory for pools of type \fBdir\fP, \fBnetfs\fP or \fBgluster\fP\&. (Default: \fBNone\fP) .IP \(bu 2 -\fBsource_initiator\fP \-\- +\fBsource_initiator\fP \-\- .sp Initiator IQN for libiscsi\-direct pool types. (Default: \fBNone\fP) .sp @@ -304385,7 +304404,7 @@ New in version 3000. .IP \(bu 2 -\fBsource_adapter\fP \-\- +\fBsource_adapter\fP \-\- .sp SCSI source definition. The value is a dictionary with \fBtype\fP, \fBname\fP, \fBparent\fP, \fBmanaged\fP, \fBparent_wwnn\fP, \fBparent_wwpn\fP, \fBparent_fabric_wwn\fP, \fBwwnn\fP, \fBwwpn\fP @@ -304401,7 +304420,7 @@ for the meaning and possible values of these properties. \fBsource_hosts\fP \-\- List of source for pools backed by storage from remote servers. Each item is the hostname optionally followed by the port separated by a colon. (Default: \fBNone\fP) .IP \(bu 2 -\fBsource_auth\fP \-\- +\fBsource_auth\fP \-\- .sp Source authentication details. (Default: \fBNone\fP) .sp @@ -304454,7 +304473,7 @@ For Ceph authentications a base64 encoded key is expected. .IP \(bu 2 \fBsource_name\fP \-\- Identifier of name\-based sources. .IP \(bu 2 -\fBsource_format\fP \-\- +\fBsource_format\fP \-\- .sp String representing the source format. The possible values are depending on the source type. See \fI\%libvirt documentation\fP for @@ -304515,7 +304534,7 @@ images \- USE WITH EXTREME CAUTION! .IP \(bu 2 \fBdirs\fP \-\- pass True to remove containing directories .IP \(bu 2 -\fBremovables\fP \-\- +\fBremovables\fP \-\- .sp pass True to remove removable devices .sp @@ -304523,7 +304542,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304531,7 +304550,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304539,7 +304558,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304572,7 +304591,7 @@ Reboot a domain via ACPI request .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304580,7 +304599,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304588,7 +304607,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304621,7 +304640,7 @@ Reset a VM by emulating the reset button on a physical machine .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304629,7 +304648,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304637,7 +304656,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304670,7 +304689,7 @@ Resume the named vm .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304678,7 +304697,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304686,7 +304705,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304723,7 +304742,7 @@ Revert snapshot to the previous from current (if available) or to the specific. .IP \(bu 2 \fBcleanup\fP \-\- Remove all newer than reverted snapshots. Values: True or False (default False). .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304731,7 +304750,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304739,7 +304758,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304810,7 +304829,7 @@ system on reboot. \fBstate\fP \-\- \(aqon\(aq to auto start the pool, anything else to mark the pool not to be started when the host boots .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304818,7 +304837,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304826,7 +304845,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304864,7 +304883,7 @@ for this to work. .IP \(bu 2 \fBconfig\fP \-\- if True then libvirt will be asked to modify the config as well .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304872,7 +304891,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304880,7 +304899,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304921,7 +304940,7 @@ If config is True then we ask libvirt to modify the config as well .IP \(bu 2 \fBconfig\fP \-\- if True then libvirt will be asked to modify the config as well .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304929,7 +304948,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304937,7 +304956,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -304971,7 +304990,7 @@ Send a soft shutdown signal to the named vm .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -304979,7 +304998,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -304987,7 +305006,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305026,7 +305045,7 @@ name with ISO 8601 time as a suffix. \fBsuffix\fP \-\- Add suffix for the new name. Useful in states, where such snapshots can be distinguished from manually created. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305034,7 +305053,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305042,7 +305061,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305078,7 +305097,7 @@ Start a defined domain .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305086,7 +305105,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305094,7 +305113,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305127,7 +305146,7 @@ Hard power down the virtual machine, this is equivalent to pulling the power. .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305135,7 +305154,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305143,7 +305162,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305177,7 +305196,7 @@ this only works if the vm is powered down .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305185,7 +305204,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305193,7 +305212,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305226,7 +305245,7 @@ Update the definition of an existing domain. .IP \(bu 2 \fBname\fP \-\- Name of the domain to update .IP \(bu 2 -\fBcpu\fP \-\- +\fBcpu\fP \-\- .sp Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is @@ -305237,7 +305256,7 @@ specify \fBNone\fP object. Please note that \fBNone\fP object is mapped to \fBnu instead. .IP \(bu 2 -\fBmem\fP \-\- +\fBmem\fP \-\- .sp Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP, @@ -305293,7 +305312,7 @@ will be attempted. (Default: \fBTrue\fP) .IP \(bu 2 \fBpassword\fP \-\- password to connect with, overriding defaults .IP \(bu 2 -\fBboot\fP \-\- +\fBboot\fP \-\- .sp Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine. This is an optional parameter, all of the keys are optional within the dictionary. @@ -305322,7 +305341,7 @@ New in version 3000. .IP \(bu 2 -\fBboot_dev\fP \-\- +\fBboot_dev\fP \-\- .sp Space separated list of devices to boot from sorted by decreasing priority. Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&. @@ -305333,7 +305352,7 @@ New in version 3002. .IP \(bu 2 -\fBnumatune\fP \-\- +\fBnumatune\fP \-\- .sp The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process @@ -305348,7 +305367,7 @@ New in version 3003. .IP \(bu 2 -\fBserials\fP \-\- +\fBserials\fP \-\- .sp Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. @@ -305357,7 +305376,7 @@ New in version 3003. .IP \(bu 2 -\fBconsoles\fP \-\- +\fBconsoles\fP \-\- .sp Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. @@ -305366,7 +305385,7 @@ New in version 3003. .IP \(bu 2 -\fBstop_on_reboot\fP \-\- +\fBstop_on_reboot\fP \-\- .sp If set to \fBTrue\fP the guest will stop instead of rebooting. This is specially useful when creating a virtual machine with an installation cdrom or @@ -305377,7 +305396,7 @@ New in version 3003. .IP \(bu 2 -\fBtest\fP \-\- +\fBtest\fP \-\- .sp run in dry\-run mode if set to True .sp @@ -305385,7 +305404,7 @@ New in version 3001. .IP \(bu 2 -\fBhypervisor_features\fP \-\- +\fBhypervisor_features\fP \-\- .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp @@ -305404,7 +305423,7 @@ hypervisor_features: .UNINDENT .IP \(bu 2 -\fBclock\fP \-\- +\fBclock\fP \-\- .sp Configure the guest clock. The value is a dictionary with the following keys: @@ -305480,7 +305499,7 @@ clock: .UNINDENT .IP \(bu 2 -\fBhost_devices\fP \-\- +\fBhost_devices\fP \-\- .sp List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fI\%node_devices()\fP function. @@ -305560,7 +305579,7 @@ list of dicts: .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305568,7 +305587,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305576,7 +305595,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305629,7 +305648,7 @@ list of dicts: .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305637,7 +305656,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305645,7 +305664,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305701,7 +305720,7 @@ list of dicts: .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305709,7 +305728,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305717,7 +305736,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305773,7 +305792,7 @@ list of dicts: .IP \(bu 2 \fBvm\fP \-\- domain name .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305781,7 +305800,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305789,7 +305808,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305850,7 +305869,7 @@ for just the named VM, otherwise it will return all VMs. .IP \(bu 2 \fBvm\fP \-\- name of the domain .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -305858,7 +305877,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -305866,7 +305885,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -305914,7 +305933,7 @@ By default, the type is guessed by libvirt from the pool type. \fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based pool types. See \fI\%Permissions definition\fP for more details on this structure. .IP \(bu 2 -\fBbacking_store\fP \-\- +\fBbacking_store\fP \-\- .sp dictionary describing a backing file for the volume. It must contain a \fBpath\fP property pointing to the base volume and a \fBformat\fP property defining the format @@ -311881,7 +311900,7 @@ category .INDENT 7.0 .TP .B Parameters -\fBcategory\fP (\fI\%str\fP) \-\- +\fBcategory\fP (\fI\%str\fP) \-\- .sp One of the nine categories to return. Can also be \fBAll\fP to return the settings for all categories. Valid options are: @@ -311959,7 +311978,7 @@ Set the configuration for the named audit setting .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The name of the setting to configure .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- +\fBvalue\fP (\fI\%str\fP) \-\- .sp The configuration for the named value. Valid options are: .INDENT 2.0 @@ -312493,7 +312512,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312574,7 +312593,7 @@ Install a package using DISM .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpackage\fP (\fI\%str\fP) \-\- +\fBpackage\fP (\fI\%str\fP) \-\- .sp The package to install. Can be a .cab file, a .msu file, or a folder .sp @@ -312634,7 +312653,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312702,7 +312721,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312733,7 +312752,7 @@ List features on the system or in a package .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The full path to the package. Can be either a .cab file or a folder. Should point to the original source of the @@ -312795,7 +312814,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312938,7 +312957,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -313096,7 +313115,7 @@ Get the type of DNS configuration (dhcp / static). .IP \(bu 2 \fBinterface\fP (\fI\%str\fP) \-\- The name of the network interface. This is the .IP \(bu 2 -\fBin the Network Connection Details for the device\fP (\fIDescription\fP) \-\- +\fBin the Network Connection Details for the device\fP (\fIDescription\fP) \-\- .UNINDENT .TP .B Returns @@ -313129,7 +313148,7 @@ Return a list of the configured DNS servers of the specified interface .IP \(bu 2 \fBinterface\fP (\fI\%str\fP) \-\- The name of the network interface. This is the name as .IP \(bu 2 -\fBappears in the Control Panel under Network Connections\fP (\fIit\fP) \-\- +\fBappears in the Control Panel under Network Connections\fP (\fIit\fP) \-\- .UNINDENT .TP .B Returns @@ -313269,7 +313288,7 @@ file a \fBconfig_name\fP must be specified. If the \fBconfig_name\fP is not specified, the name of the file will be used as the \fBconfig_name\fP to run. Optional. .IP \(bu 2 -\fBconfig_data\fP (\fI\%str\fP) \-\- +\fBconfig_data\fP (\fI\%str\fP) \-\- .sp Configuration data in the form of a hash table that will be passed to the \fBConfigurationData\fP parameter when the @@ -313281,7 +313300,7 @@ New in version 2017.7.0. .IP \(bu 2 -\fBconfig_data_source\fP (\fI\%str\fP) \-\- +\fBconfig_data_source\fP (\fI\%str\fP) \-\- .sp The path to the \fB\&.psd1\fP file on \fBfile_roots\fP to cache at the location specified by @@ -313292,7 +313311,7 @@ New in version 2017.7.0. .IP \(bu 2 -\fBscript_parameters\fP (\fI\%str\fP) \-\- +\fBscript_parameters\fP (\fI\%str\fP) \-\- .sp Any additional parameters expected by the configuration script. These must be defined in the script itself. @@ -313437,7 +313456,7 @@ New in version 2017.7.5. .INDENT 7.0 .TP .B Parameters -\fBreset\fP (\fI\%bool\fP) \-\- +\fBreset\fP (\fI\%bool\fP) \-\- .sp Attempts to reset the DSC configuration by removing the following from \fBC:\eWindows\eSystem32\eConfiguration\fP: @@ -313553,7 +313572,7 @@ file a \fBconfig_name\fP must be specified. If the \fBconfig_name\fP is not specified, the name of the file will be used as the \fBconfig_name\fP to run. Optional. .IP \(bu 2 -\fBconfig_data\fP (\fI\%str\fP) \-\- +\fBconfig_data\fP (\fI\%str\fP) \-\- .sp Configuration data in the form of a hash table that will be passed to the \fBConfigurationData\fP parameter when the @@ -313565,7 +313584,7 @@ New in version 2017.7.0. .IP \(bu 2 -\fBconfig_data_source\fP (\fI\%str\fP) \-\- +\fBconfig_data_source\fP (\fI\%str\fP) \-\- .sp The path to the \fB\&.psd1\fP file on \fBfile_roots\fP to cache at the location specified by @@ -313576,7 +313595,7 @@ New in version 2017.7.0. .IP \(bu 2 -\fBscript_parameters\fP (\fI\%str\fP) \-\- +\fBscript_parameters\fP (\fI\%str\fP) \-\- .sp Any additional parameters expected by the configuration script. These must be defined in the script itself. @@ -314465,7 +314484,7 @@ Ensure that the parent directory containing this path is available. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpath\fP (\fI\%str\fP) \-\- +\fBpath\fP (\fI\%str\fP) \-\- .sp The full path to the directory. .sp @@ -314485,7 +314504,7 @@ like \fBC:\etemp\etest\e\fP, then it would be treated as \fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM. .IP \(bu 2 -\fBgrant_perms\fP (\fI\%dict\fP) \-\- +\fBgrant_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing the user/group and the basic permissions to grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also @@ -314525,7 +314544,7 @@ grant permissions. False, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. .IP \(bu 2 -\fBreset\fP (\fI\%bool\fP) \-\- +\fBreset\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP the existing DACL will be cleared and replaced with the settings defined in this function. If \fBFalse\fP, new entries will be @@ -314579,7 +314598,7 @@ Set owner and permissions for each directory created. \fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM. .IP \(bu 2 -\fBgrant_perms\fP (\fI\%dict\fP) \-\- +\fBgrant_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing the user/group and the basic permissions to grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also @@ -314619,7 +314638,7 @@ grant permissions. \fBFalse\fP, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created .IP \(bu 2 -\fBreset\fP (\fI\%bool\fP) \-\- +\fBreset\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP the existing DACL will be cleared and replaced with the settings defined in this function. If \fBFalse\fP, new entries will be @@ -314670,7 +314689,7 @@ Ensure that the directory is available and permissions are set. \fBowner\fP (\fI\%str\fP) \-\- The owner of the directory. If not passed, it will be the account that created the directory, likely SYSTEM .IP \(bu 2 -\fBgrant_perms\fP (\fI\%dict\fP) \-\- +\fBgrant_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing the user/group and the basic permissions to grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also @@ -314711,7 +314730,7 @@ grant permissions. \fBFalse\fP, inheritance will be disabled. Inheritance setting will not apply to parent directories if they must be created. .IP \(bu 2 -\fBreset\fP (\fI\%bool\fP) \-\- +\fBreset\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP the existing DACL will be cleared and replaced with the settings defined in this function. If \fBFalse\fP, new entries will be @@ -314910,7 +314929,7 @@ Set permissions for the given path .IP \(bu 2 \fBpath\fP (\fI\%str\fP) \-\- The full path to the directory. .IP \(bu 2 -\fBgrant_perms\fP (\fI\%dict\fP) \-\- +\fBgrant_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing the user/group and the basic permissions to grant, ie: \fB{\(aquser\(aq: {\(aqperms\(aq: \(aqbasic_permission\(aq}}\fP\&. You can also @@ -314948,7 +314967,7 @@ A value of \fBNone\fP will make no changes to the \fBgrant\fP portion of the DACL. Default is \fBNone\fP\&. .IP \(bu 2 -\fBdeny_perms\fP (\fI\%dict\fP) \-\- +\fBdeny_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing the user/group and permissions to deny along with the \fBapplies_to\fP setting. Use the same format used for the @@ -314964,7 +314983,7 @@ the DACL. Default is \fBNone\fP\&. not apply to parent directories if they must be created. Default is \fBFalse\fP\&. .IP \(bu 2 -\fBreset\fP (\fI\%bool\fP) \-\- +\fBreset\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP the existing DCL will be cleared and replaced with the settings defined in this function. If \fBFalse\fP, new entries will be @@ -315169,7 +315188,7 @@ Required. 0 and 65535. Can be a range. Can specify multiple ports separated by commas. Required. .IP \(bu 2 -\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The protocol. Can be any of the following: .INDENT 2.0 @@ -315188,7 +315207,7 @@ any .UNINDENT .IP \(bu 2 -\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The action the rule performs. Can be any of the following: @@ -315204,7 +315223,7 @@ bypass .IP \(bu 2 \fBdir\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The direction. Can be \fBin\fP or \fBout\fP\&. .IP \(bu 2 -\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\- +\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\- .sp The remote IP. Can be any of the following: .INDENT 2.0 @@ -315327,7 +315346,7 @@ Disable firewall profile .INDENT 7.0 .TP .B Parameters -\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the profile to disable. Default is \fBallprofiles\fP\&. Valid options are: @@ -315375,7 +315394,7 @@ Enable firewall profile .INDENT 7.0 .TP .B Parameters -\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the profile to enable. Default is \fBallprofiles\fP\&. Valid options are: @@ -315426,7 +315445,7 @@ New in version 2019.2.0. .INDENT 7.0 .TP .B Parameters -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -315480,7 +315499,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to query. Valid options are: .INDENT 2.0 @@ -315493,7 +315512,7 @@ private .UNINDENT .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -315611,7 +315630,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to query. Valid options are: .INDENT 2.0 @@ -315624,7 +315643,7 @@ private .UNINDENT .IP \(bu 2 -\fBsection\fP (\fI\%str\fP) \-\- +\fBsection\fP (\fI\%str\fP) \-\- .sp The property to query within the selected profile. Valid options are: @@ -315640,7 +315659,7 @@ state : firewalls state (on | off) .UNINDENT .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -315736,7 +315755,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to query. Valid options are: .INDENT 2.0 @@ -315749,7 +315768,7 @@ private .UNINDENT .IP \(bu 2 -\fBinbound\fP (\fI\%str\fP) \-\- +\fBinbound\fP (\fI\%str\fP) \-\- .sp The inbound setting. If \fBNone\fP is passed, the setting will remain unchanged. Valid values are: @@ -315767,7 +315786,7 @@ notconfigured Default is \fBNone\fP .IP \(bu 2 -\fBoutbound\fP (\fI\%str\fP) \-\- +\fBoutbound\fP (\fI\%str\fP) \-\- .sp The outbound setting. If \fBNone\fP is passed, the setting will remain unchanged. Valid values are: @@ -315783,7 +315802,7 @@ notconfigured Default is \fBNone\fP .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -315850,7 +315869,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to configure. Valid options are: .INDENT 2.0 @@ -315863,7 +315882,7 @@ private .UNINDENT .IP \(bu 2 -\fBsetting\fP (\fI\%str\fP) \-\- +\fBsetting\fP (\fI\%str\fP) \-\- .sp The logging setting to configure. Valid options are: .INDENT 2.0 @@ -315878,7 +315897,7 @@ maxfilesize .UNINDENT .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- +\fBvalue\fP (\fI\%str\fP) \-\- .sp The value to apply to the setting. Valid values are dependent upon the setting being configured. Valid options are: @@ -315943,7 +315962,7 @@ notconfigured .UNINDENT .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -316013,7 +316032,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to configure. Valid options are: .INDENT 2.0 @@ -316026,7 +316045,7 @@ private .UNINDENT .IP \(bu 2 -\fBsetting\fP (\fI\%str\fP) \-\- +\fBsetting\fP (\fI\%str\fP) \-\- .sp The firewall setting to configure. Valid options are: .INDENT 2.0 @@ -316043,7 +316062,7 @@ unicastresponsetomulticast .UNINDENT .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- +\fBvalue\fP (\fI\%str\fP) \-\- .sp The value to apply to the setting. Valid options are .INDENT 2.0 @@ -316063,7 +316082,7 @@ notconfigured .UNINDENT .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -316124,7 +316143,7 @@ New in version 2019.2.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprofile\fP (\fI\%str\fP) \-\- +\fBprofile\fP (\fI\%str\fP) \-\- .sp The firewall profile to configure. Valid options are: .INDENT 2.0 @@ -316137,7 +316156,7 @@ private .UNINDENT .IP \(bu 2 -\fBstate\fP (\fI\%str\fP) \-\- +\fBstate\fP (\fI\%str\fP) \-\- .sp The firewall state. Valid options are: .INDENT 2.0 @@ -316157,7 +316176,7 @@ notconfigured .UNINDENT .IP \(bu 2 -\fBstore\fP (\fI\%str\fP) \-\- +\fBstore\fP (\fI\%str\fP) \-\- .sp The store to use. This is either the local firewall policy or the policy defined by local group policy. Valid options are: @@ -318223,7 +318242,7 @@ default is \fBen\-US\fP name of the policy. \fBreturn_full_policy_names\fP and \fBhierarchical_return\fP will be ignored. Default is \fBTrue\fP .IP \(bu 2 -\fBreturn_full_policy_names\fP (\fI\%bool\fP) \-\- +\fBreturn_full_policy_names\fP (\fI\%bool\fP) \-\- .sp Returns the full policy name regardless of what was passed in \fBpolicy_name\fP @@ -318472,7 +318491,7 @@ Set a local server policy. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcomputer_policy\fP (\fI\%dict\fP) \-\- +\fBcomputer_policy\fP (\fI\%dict\fP) \-\- .sp A dictionary of "policyname: value" pairs of computer policies to set. \(aqvalue\(aq should be how it is displayed in the gpedit GUI, i.e. @@ -318528,7 +318547,7 @@ the element ID/names that the module will accept. \fBuser_policy\fP (\fI\%dict\fP) \-\- The same setup as the computer_policy, except with data to configure the local user policy. .IP \(bu 2 -\fBcumulative_rights_assignments\fP (\fI\%bool\fP) \-\- +\fBcumulative_rights_assignments\fP (\fI\%bool\fP) \-\- .sp Determine how user rights assignment policies are configured. .sp @@ -319601,7 +319620,7 @@ to install. (no spaces after the commas) \fBrefresh\fP (\fI\%bool\fP) \-\- Boolean value representing whether or not to refresh the winrepo db. Default \fBFalse\fP\&. .IP \(bu 2 -\fBpkgs\fP (\fI\%list\fP) \-\- +\fBpkgs\fP (\fI\%list\fP) \-\- .sp A list of packages to install from a software repository. All packages listed under \fBpkgs\fP will be installed via a single @@ -320726,7 +320745,7 @@ Get the current disk timeout of the given scheme .INDENT 7.0 .TP .B Parameters -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -320819,7 +320838,7 @@ Get the current monitor timeout of the given scheme .INDENT 7.0 .TP .B Parameters -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -320916,7 +320935,7 @@ Set the disk timeout in minutes for the given power scheme .IP \(bu 2 \fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the disk will timeout .IP \(bu 2 -\fBpower\fP (\fI\%str\fP) \-\- +\fBpower\fP (\fI\%str\fP) \-\- .sp Set the value for AC or DC power. Default is \fBac\fP\&. Valid options are: @@ -320932,7 +320951,7 @@ are: .UNINDENT .IP \(bu 2 -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -320983,7 +321002,7 @@ Set the hibernate timeout in minutes for the given power scheme .IP \(bu 2 \fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the computer hibernates .IP \(bu 2 -\fBpower\fP (\fI\%str\fP) \-\- +\fBpower\fP (\fI\%str\fP) \-\- .sp Set the value for AC or DC power. Default is \fBac\fP\&. Valid options are: @@ -320999,7 +321018,7 @@ are: .UNINDENT .IP \(bu 2 -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -321050,7 +321069,7 @@ Set the monitor timeout in minutes for the given power scheme .IP \(bu 2 \fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the monitor will timeout .IP \(bu 2 -\fBpower\fP (\fI\%str\fP) \-\- +\fBpower\fP (\fI\%str\fP) \-\- .sp Set the value for AC or DC power. Default is \fBac\fP\&. Valid options are: @@ -321066,7 +321085,7 @@ are: .UNINDENT .IP \(bu 2 -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -321117,7 +321136,7 @@ Set the standby timeout in minutes for the given power scheme .IP \(bu 2 \fBtimeout\fP (\fI\%int\fP) \-\- The amount of time in minutes before the computer sleeps .IP \(bu 2 -\fBpower\fP (\fI\%str\fP) \-\- +\fBpower\fP (\fI\%str\fP) \-\- .sp Set the value for AC or DC power. Default is \fBac\fP\&. Valid options are: @@ -321133,7 +321152,7 @@ are: .UNINDENT .IP \(bu 2 -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -321428,7 +321447,7 @@ a long timeout .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- +\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- .sp The name of the feature(s) to install. This can be a single feature, a string of features in a comma delimited list (no spaces), or a @@ -321449,7 +321468,7 @@ False means that the system will use windows update services to find the required files. Default is None .IP \(bu 2 -\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the feature to exclude when installing the named feature. This can be a single feature, a string of features in a @@ -321572,7 +321591,7 @@ idea to use the \fB\-t\fP option to set a longer timeout. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- +\fBfeature\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- .sp The name of the feature(s) to remove. This can be a single feature, a string of features in a comma delimited list (no spaces), or a @@ -321666,7 +321685,7 @@ escaped, eg: \fBC:\epath\eto\ebinary.exe\fP .IP \(bu 2 \fBdescription\fP (\fI\%str\fP) \-\- A description of the service .IP \(bu 2 -\fBservice_type\fP (\fI\%str\fP) \-\- +\fBservice_type\fP (\fI\%str\fP) \-\- .sp Specifies the service type. Default is \fBown\fP\&. Valid options are as follows: @@ -321686,7 +321705,7 @@ share: Service shares a process with one or more other services .UNINDENT .IP \(bu 2 -\fBstart_type\fP (\fI\%str\fP) \-\- +\fBstart_type\fP (\fI\%str\fP) \-\- .sp Specifies the service start type. Valid options are as follows: .INDENT 2.0 @@ -321708,7 +321727,7 @@ is set to \fBAuto\fP\&. If service_type is not passed, but the service is already set to \fBAuto\fP, then the flag will be set. Default is \fBFalse\fP .IP \(bu 2 -\fBerror_control\fP (\fI\%str\fP) \-\- +\fBerror_control\fP (\fI\%str\fP) \-\- .sp The severity of the error, and action taken, if this service fails to start. Valid options are as follows: @@ -321732,7 +321751,7 @@ given to the user \fBdependencies\fP (\fI\%list\fP) \-\- A list of services or load ordering groups that must start before this service .IP \(bu 2 -\fBaccount_name\fP (\fI\%str\fP) \-\- +\fBaccount_name\fP (\fI\%str\fP) \-\- .sp The name of the account under which the service should run. For \fBown\fP type services this should be in the \fBdomain\eusername\fP @@ -321814,7 +321833,7 @@ Delete the named service .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The name of the service to delete .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The time in seconds to wait for the service to be deleted before returning. This is necessary because a service must be stopped @@ -321916,7 +321935,7 @@ Enable the named service to start at boot .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The name of the service to enable. .IP \(bu 2 -\fBstart_type\fP (\fI\%str\fP) \-\- +\fBstart_type\fP (\fI\%str\fP) \-\- .sp Specifies the service start type. Valid options are as follows: @@ -322234,7 +322253,7 @@ New in version 2016.11.0. .IP \(bu 2 \fBdescription\fP (\fI\%str\fP) \-\- The description to display for the service .IP \(bu 2 -\fBservice_type\fP (\fI\%str\fP) \-\- +\fBservice_type\fP (\fI\%str\fP) \-\- .sp Specifies the service type. Default is \fBown\fP\&. Valid options are as follows: @@ -322254,7 +322273,7 @@ share: Service shares a process with one or more other services .UNINDENT .IP \(bu 2 -\fBstart_type\fP (\fI\%str\fP) \-\- +\fBstart_type\fP (\fI\%str\fP) \-\- .sp Specifies the service start type. Valid options are as follows: .INDENT 2.0 @@ -322275,7 +322294,7 @@ disabled: Service cannot be started is set to \fBAuto\fP\&. If service_type is not passed, but the service is already set to \fBAuto\fP, then the flag will be set. .IP \(bu 2 -\fBerror_control\fP (\fI\%str\fP) \-\- +\fBerror_control\fP (\fI\%str\fP) \-\- .sp The severity of the error, and action taken, if this service fails to start. Valid options are as follows: @@ -322299,7 +322318,7 @@ given to the user \fBdependencies\fP (\fI\%list\fP) \-\- A list of services or load ordering groups that must start before this service .IP \(bu 2 -\fBaccount_name\fP (\fI\%str\fP) \-\- +\fBaccount_name\fP (\fI\%str\fP) \-\- .sp The name of the account under which the service should run. For \fBown\fP type services this should be in the \fBdomain\eusername\fP @@ -322354,7 +322373,7 @@ Restart the named service. This issues a stop command followed by a start. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP \-\- +\fBname\fP \-\- .sp The name of the service to restart. .sp @@ -322367,7 +322386,7 @@ created and executed to restart the salt\-minion service. .UNINDENT .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The time in seconds to wait for the service to stop and start before returning. Default is 90 seconds @@ -322424,7 +322443,7 @@ disabled, it will be changed to \fBManual\fP start. .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The name of the service to start .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The time in seconds to wait for the service to start before returning. Default is 90 seconds @@ -322503,7 +322522,7 @@ Stop the specified service .IP \(bu 2 \fBname\fP (\fI\%str\fP) \-\- The name of the service to stop .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The time in seconds to wait for the service to stop before returning. Default is 90 seconds @@ -323932,7 +323951,7 @@ Return the system uptime for the machine .INDENT 7.0 .TP .B Parameters -\fBhuman_readable\fP (\fI\%bool\fP) \-\- +\fBhuman_readable\fP (\fI\%bool\fP) \-\- .sp Return uptime in human readable format if \fBTrue\fP, otherwise return seconds. Default is \fBFalse\fP @@ -324519,7 +324538,7 @@ Halt a running system. .IP \(bu 2 \fBtimeout\fP (\fI\%int\fP) \-\- Number of seconds before halting the system. Default is 5 seconds. .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp Whether to treat timeout as seconds or minutes. .sp @@ -324592,7 +324611,7 @@ account already exists. If set to \fBFalse\fP the computer account will be created if it does not exist, otherwise it will use the existing account. Default is \fBFalse\fP .IP \(bu 2 -\fBrestart\fP (\fI\%bool\fP) \-\- +\fBrestart\fP (\fI\%bool\fP) \-\- .sp \fBTrue\fP will restart the computer after a successful join. Default is \fBFalse\fP @@ -324661,7 +324680,7 @@ Power off a running system. \fBtimeout\fP (\fI\%int\fP) \-\- Number of seconds before powering off the system. Default is 5 seconds. .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp Whether to treat timeout as seconds or minutes. .sp @@ -324712,7 +324731,7 @@ New in version 2015.8.0. .IP \(bu 2 -\fBwait_for_reboot\fP (\fI\%bool\fP) \-\- +\fBwait_for_reboot\fP (\fI\%bool\fP) \-\- .sp \fBTrue\fP will sleep for timeout + 30 seconds after reboot has been initiated. This is useful for use in a highstate. For example, you @@ -324933,7 +324952,7 @@ Set the Windows system date. Use format for the date. .INDENT 7.0 .TP .B Parameters -\fBnewdate\fP (\fI\%str\fP) \-\- +\fBnewdate\fP (\fI\%str\fP) \-\- .sp The date to set. Can be any of the following formats .INDENT 7.0 @@ -325022,7 +325041,7 @@ Set the system time. .INDENT 7.0 .TP .B Parameters -\fBnewtime\fP (\fI\%str\fP) \-\- +\fBnewtime\fP (\fI\%str\fP) \-\- .sp The time to set. Can be any of the following formats: .INDENT 7.0 @@ -325067,7 +325086,7 @@ Shutdown a running system. .IP \(bu 2 \fBmessage\fP (\fI\%str\fP) \-\- The message to display to the user before shutting down. .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The length of time (in seconds) that the shutdown dialog box should be displayed. While this dialog box is displayed, the shutdown can @@ -325256,7 +325275,7 @@ be \fBNone\fP\&. .IP \(bu 2 \fBdomain\fP (\fI\%str\fP) \-\- The domain from which to unjoin the computer. Can be \fBNone\fP .IP \(bu 2 -\fBworkgroup\fP (\fI\%str\fP) \-\- +\fBworkgroup\fP (\fI\%str\fP) \-\- .sp The workgroup to join the computer to. Default is \fBWORKGROUP\fP .sp @@ -325267,7 +325286,7 @@ New in version 2015.8.2/2015.5.7. \fBdisable\fP (\fI\%bool\fP) \-\- \fBTrue\fP to disable the computer account in Active Directory. Default is \fBFalse\fP .IP \(bu 2 -\fBrestart\fP (\fI\%bool\fP) \-\- +\fBrestart\fP (\fI\%bool\fP) \-\- .sp \fBTrue\fP will restart the computer after successful unjoin. Default is \fBFalse\fP @@ -325324,7 +325343,7 @@ Add an action to a task. \fB\e\fP which is the root for the task scheduler (\fBC:\eWindows\eSystem32\etasks\fP). .IP \(bu 2 -\fBaction_type\fP (\fI\%str\fP) \-\- +\fBaction_type\fP (\fI\%str\fP) \-\- .sp The type of action to add. There are three action types. Each one requires its own set of Keyword Arguments (kwargs). Valid values @@ -325483,7 +325502,7 @@ See \fI\%YAML IDIOSYNCRASIES\fP for more details. \fB\e\fP which is the root for the task scheduler (\fBC:\eWindows\eSystem32\etasks\fP). .IP \(bu 2 -\fBtrigger_type\fP (\fI\%str\fP) \-\- +\fBtrigger_type\fP (\fI\%str\fP) \-\- .sp The type of trigger to create. This is defined when the trigger is created and cannot be changed later. Options are as follows: @@ -325519,7 +325538,7 @@ OnSessionChange .IP \(bu 2 \fBtrigger_enabled\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether the trigger is enabled. .IP \(bu 2 -\fBstart_date\fP (\fI\%str\fP) \-\- +\fBstart_date\fP (\fI\%str\fP) \-\- .sp The date when the trigger is activated. If no value is passed, the current date will be used. Can be one of the following formats: @@ -325543,7 +325562,7 @@ current date will be used. Can be one of the following formats: .UNINDENT .IP \(bu 2 -\fBstart_time\fP (\fI\%str\fP) \-\- +\fBstart_time\fP (\fI\%str\fP) \-\- .sp The time when the trigger is activated. If no value is passed, midnight will be used. Can be one of the following formats: @@ -325563,7 +325582,7 @@ midnight will be used. Can be one of the following formats: .UNINDENT .IP \(bu 2 -\fBend_date\fP (\fI\%str\fP) \-\- +\fBend_date\fP (\fI\%str\fP) \-\- .sp The date when the trigger is deactivated. The trigger cannot start the task after it is deactivated. Can be one of the following @@ -325588,7 +325607,7 @@ formats: .UNINDENT .IP \(bu 2 -\fBend_time\fP (\fI\%str\fP) \-\- +\fBend_time\fP (\fI\%str\fP) \-\- .sp The time when the trigger is deactivated. If this is not passed with \fBend_date\fP it will be set to midnight. Can be one of the @@ -325609,7 +325628,7 @@ following formats: .UNINDENT .IP \(bu 2 -\fBrandom_delay\fP (\fI\%str\fP) \-\- +\fBrandom_delay\fP (\fI\%str\fP) \-\- .sp The delay time that is randomly added to the start time of the trigger. Valid values are: @@ -325656,7 +325675,7 @@ MonthlyDay .UNINDENT .IP \(bu 2 -\fBrepeat_interval\fP (\fI\%str\fP) \-\- +\fBrepeat_interval\fP (\fI\%str\fP) \-\- .sp The amount of time between each restart of the task. Valid values are: @@ -325678,7 +325697,7 @@ are: .UNINDENT .IP \(bu 2 -\fBrepeat_duration\fP (\fI\%str\fP) \-\- +\fBrepeat_duration\fP (\fI\%str\fP) \-\- .sp How long the pattern is repeated. Valid values are: .INDENT 2.0 @@ -325704,7 +325723,7 @@ Indefinitely \fBrepeat_stop_at_duration_end\fP (\fI\%bool\fP) \-\- Boolean value that indicates if a running instance of the task is stopped at the end of the repetition pattern duration. .IP \(bu 2 -\fBexecution_time_limit\fP (\fI\%str\fP) \-\- +\fBexecution_time_limit\fP (\fI\%str\fP) \-\- .sp The maximum amount of time that the task launched by the trigger is allowed to run. Valid values are: @@ -325732,7 +325751,7 @@ allowed to run. Valid values are: .UNINDENT .IP \(bu 2 -\fBdelay\fP (\fI\%str\fP) \-\- +\fBdelay\fP (\fI\%str\fP) \-\- .sp The time the trigger waits after its activation to start the task. Valid values are: @@ -326199,7 +326218,7 @@ str: A string with the error message if there is an error .IP \(bu 2 \fBArgumentValueError\fP \-\- If arguments are invalid .IP \(bu 2 -\fBCommandExecutionError\fP \-\- +\fBCommandExecutionError\fP \-\- .UNINDENT .UNINDENT .sp @@ -326303,7 +326322,7 @@ task. Default is \fB\e\fP which is the root for the task scheduler \fBuser_name\fP (\fI\%str\fP) \-\- The user account under which to run the task. To specify the \(aqSystem\(aq account, use \(aqSystem\(aq. The password will be ignored. .IP \(bu 2 -\fBpassword\fP (\fI\%str\fP) \-\- +\fBpassword\fP (\fI\%str\fP) \-\- .sp The password to use for authentication. This should set the task to run whether the user is logged in or not, but is currently not @@ -326333,7 +326352,7 @@ description field in the task scheduler. \fBrun_if_idle\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle state. .IP \(bu 2 -\fBidle_duration\fP (\fI\%str\fP) \-\- +\fBidle_duration\fP (\fI\%str\fP) \-\- .sp A value that indicates the amount of time that the computer must be in an idle state before the task is run. Valid values are: @@ -326357,7 +326376,7 @@ in an idle state before the task is run. Valid values are: .UNINDENT .IP \(bu 2 -\fBidle_wait_timeout\fP (\fI\%str\fP) \-\- +\fBidle_wait_timeout\fP (\fI\%str\fP) \-\- .sp A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. Valid values are: @@ -326414,7 +326433,7 @@ either the Run command or the Context menu. \fBstart_when_available\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. .IP \(bu 2 -\fBrestart_every\fP (\fI\%str\fP) \-\- +\fBrestart_every\fP (\fI\%str\fP) \-\- .sp A value that specifies the interval between task restart attempts. Valid values are: @@ -326445,7 +326464,7 @@ False (to disable) \fBrestart_count\fP (\fI\%int\fP) \-\- The number of times the Task Scheduler will attempt to restart the task. Valid values are integers 1 \- 999. .IP \(bu 2 -\fBexecution_time_limit\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\- +\fBexecution_time_limit\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\- .sp The amount of time allowed to complete the task. Valid values are: .INDENT 2.0 @@ -326475,7 +326494,7 @@ False (to disable) \fBforce_stop\fP (\fI\%bool\fP) \-\- Boolean value that indicates that the task may be terminated by using TerminateProcess. .IP \(bu 2 -\fBdelete_after\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\- +\fBdelete_after\fP (\fI\%bool\fP\fI, \fP\fI\%str\fP) \-\- .sp The amount of time that the Task Scheduler will wait before deleting the task after it expires. Requires a trigger with an expiration @@ -326500,7 +326519,7 @@ Immediately .UNINDENT .IP \(bu 2 -\fBmultiple_instances\fP (\fI\%str\fP) \-\- +\fBmultiple_instances\fP (\fI\%str\fP) \-\- .sp Sets the policy that defines how the Task Scheduler deals with multiple instances of the task. Valid values are: @@ -327943,7 +327962,7 @@ options than \fI\%list()\fP\&. Good for finding a specific GUID or KB. .IP \(bu 2 \fBskip_reboot\fP (\fI\%bool\fP) \-\- Skip updates that require a reboot. Default is \fBFalse\fP .IP \(bu 2 -\fBcategories\fP (\fI\%list\fP) \-\- +\fBcategories\fP (\fI\%list\fP) \-\- .sp Specify the categories to list. Must be passed as a list. All categories returned by default. @@ -327979,7 +327998,7 @@ Windows Defender .UNINDENT .IP \(bu 2 -\fBseverities\fP (\fI\%list\fP) \-\- +\fBseverities\fP (\fI\%list\fP) \-\- .sp Specify the severities to include. Must be passed as a list. All severities returned by default. @@ -327993,7 +328012,7 @@ Important .UNINDENT .IP \(bu 2 -\fBonline\fP (\fI\%bool\fP) \-\- +\fBonline\fP (\fI\%bool\fP) \-\- .sp Tells the Windows Update Agent go online to update its local update database. \fBTrue\fP will go online. \fBFalse\fP will use the local @@ -328090,7 +328109,7 @@ use this function by using list_updates and setting \fBdownload=True\fP\&. .INDENT 7.0 .TP .B Parameters -\fBnames\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- +\fBnames\fP (\fI\%str\fP\fI, \fP\fI\%list\fP) \-\- .sp A single update or a list of updates to download. This can be any combination of GUIDs, KB numbers, or names. GUIDs or KBs are @@ -328150,7 +328169,7 @@ download the update. first to see if the update exists, then set \fBinstall=True\fP to install the update. .IP \(bu 2 -\fBonline\fP (\fI\%bool\fP) \-\- +\fBonline\fP (\fI\%bool\fP) \-\- .sp Tells the Windows Update Agent go online to update its local update database. \fBTrue\fP will go online. \fBFalse\fP will use the local @@ -328495,7 +328514,7 @@ returned by this function. Run this function first with \fBinstall=False\fP to see what will be installed, then set \fBinstall=True\fP to install the updates. Default is \fBFalse\fP .IP \(bu 2 -\fBcategories\fP (\fI\%list\fP) \-\- +\fBcategories\fP (\fI\%list\fP) \-\- .sp Specify the categories to list. Must be passed as a list. All categories returned by default. @@ -328531,7 +328550,7 @@ Windows Defender .UNINDENT .IP \(bu 2 -\fBseverities\fP (\fI\%list\fP) \-\- +\fBseverities\fP (\fI\%list\fP) \-\- .sp Specify the severities to include. Must be passed as a list. All severities returned by default. @@ -328545,7 +328564,7 @@ Important .UNINDENT .IP \(bu 2 -\fBonline\fP (\fI\%bool\fP) \-\- +\fBonline\fP (\fI\%bool\fP) \-\- .sp Tells the Windows Update Agent go online to update its local update database. \fBTrue\fP will go online. \fBFalse\fP will use the local @@ -328655,7 +328674,7 @@ Windows 8.1 / Server 2012R2 .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlevel\fP (\fI\%int\fP) \-\- +\fBlevel\fP (\fI\%int\fP) \-\- .sp Number from 1 to 4 indicating the update level: .INDENT 2.0 @@ -328684,7 +328703,7 @@ some update\-related actions without administrator approval. \fBmsupdate\fP (\fI\%bool\fP) \-\- Boolean value that indicates whether to turn on Microsoft Update for other Microsoft products .IP \(bu 2 -\fBday\fP (\fI\%str\fP) \-\- +\fBday\fP (\fI\%str\fP) \-\- .sp Days of the week on which Automatic Updates installs or uninstalls updates. Accepted values: @@ -328972,9 +328991,9 @@ it directly processes the file specified in \fIname\fP .IP \(bu 2 \fBstr\fP (\fIsaltenv\fP) \-\- The name/path of the package you want to view. This can be the .IP \(bu 2 -\fBpath to a file on the minion file system\fP\fB or \fP\fBa file on the local\fP (\fIfull\fP) \-\- +\fBpath to a file on the minion file system\fP\fB or \fP\fBa file on the local\fP (\fIfull\fP) \-\- .IP \(bu 2 -\fBcache.\fP (\fIminion\fP) \-\- +\fBcache.\fP (\fIminion\fP) \-\- .IP \(bu 2 \fBstr\fP \-\- The default environment is \fBbase\fP .UNINDENT @@ -331467,8 +331486,8 @@ Alternate constructor that accept multiple recipients and rooms .B filter(record) Determine if the specified record is to be logged. .sp -Returns True if the record should be logged, or False otherwise. -If deemed appropriate, the record may be modified in\-place. +Is the specified record to be logged? Returns 0 for no, nonzero for +yes. If deemed appropriate, the record may be modified in\-place. .UNINDENT .UNINDENT .INDENT 0.0 @@ -334410,7 +334429,7 @@ Retrieve mediatypes according to the given parameters. .IP \(bu 2 \fBmediatypeids\fP \-\- ids of the mediatypes .IP \(bu 2 -\fBconnection_args\fP (\fIoptional\fP) \-\- +\fBconnection_args\fP (\fIoptional\fP) \-\- .sp _connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring) _connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring) @@ -334494,7 +334513,7 @@ Send Zabbix API call .IP \(bu 2 \fBparams\fP \-\- parameters required for specific method .IP \(bu 2 -\fBconnection_args\fP (\fIoptional\fP) \-\- +\fBconnection_args\fP (\fIoptional\fP) \-\- .sp _connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring) _connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring) @@ -334567,7 +334586,7 @@ Retrieve templates according to the given parameters. .IP \(bu 2 \fBhostids\fP \-\- ids of the templates .IP \(bu 2 -\fBconnection_args\fP (\fIoptional\fP) \-\- +\fBconnection_args\fP (\fIoptional\fP) \-\- .sp _connection_user: zabbix user (can also be set in opts or pillar, see module\(aqs docstring) _connection_password: zabbix password (can also be set in opts or pillar, see module\(aqs docstring) @@ -339863,7 +339882,7 @@ Return the information of the named package(s), installed on the system. .IP \(bu 2 \fBnames\fP \-\- Names of the packages to get information about. .IP \(bu 2 -\fBattr\fP \-\- +\fBattr\fP \-\- .sp Comma\-separated package attributes. If no \(aqattr\(aq is specified, all available attributes returned. .INDENT 2.0 @@ -339875,7 +339894,7 @@ summary, description. .UNINDENT .IP \(bu 2 -\fBerrors\fP \-\- +\fBerrors\fP \-\- .sp Handle RPM field errors. If \(aqignore\(aq is chosen, then various mistakes are simply ignored and omitted from the texts or strings. If \(aqreport\(aq is chonen, then a field with a mistake is not returned, instead @@ -348085,7 +348104,7 @@ ext_pillar: .IP \(bu 2 \fBpillar\fP \-\- Unused by the \fBfile_tree\fP pillar module .IP \(bu 2 -\fBroot_dir\fP \-\- +\fBroot_dir\fP \-\- .sp Filesystem directory used as the root for pillar data (e.g. \fB/srv/ext_pillar\fP) @@ -348098,7 +348117,7 @@ merging the results. .IP \(bu 2 -\fBfollow_dir_links\fP \-\- +\fBfollow_dir_links\fP \-\- .sp Follow symbolic links to directories while collecting pillar files. Defaults to \fBFalse\fP\&. @@ -348123,7 +348142,7 @@ Symbolic links that lead to infinite recursion are not filtered. \fBFalse\fP\&. This option may be useful to help debug errors when setting up the \fBfile_tree\fP pillar module. .IP \(bu 2 -\fBkeep_newline\fP \-\- +\fBkeep_newline\fP \-\- .sp Preserve the end\-of\-file newline in files. Defaults to \fBFalse\fP\&. This option may either be a boolean or a list of file globs (as defined @@ -348168,7 +348187,7 @@ files. .UNINDENT .IP \(bu 2 -\fBrender_default\fP \-\- +\fBrender_default\fP \-\- .sp Override Salt\(aqs \fBdefault global renderer\fP for the \fBfile_tree\fP pillar. @@ -348184,7 +348203,7 @@ render_default: jinja .UNINDENT .IP \(bu 2 -\fBrenderer_blacklist\fP \-\- +\fBrenderer_blacklist\fP \-\- .sp Disallow renderers for pillar files. .INDENT 2.0 @@ -348200,7 +348219,7 @@ renderer_blacklist: .UNINDENT .IP \(bu 2 -\fBrenderer_whitelist\fP \-\- +\fBrenderer_whitelist\fP \-\- .sp Allow renderers for pillar files. .INDENT 2.0 @@ -370344,7 +370363,7 @@ Get args and kwargs from the argset. .INDENT 7.0 .TP .B Parameters -\fBargset\fP \-\- +\fBargset\fP \-\- .TP .B Returns @@ -372488,13 +372507,13 @@ value to prevent accidentally overwritting any concurrent changes. \fBif_none_match\fP \-\- Set to \(aq*\(aq to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. .IP \(bu 2 -\fBregistration_virtual_networks\fP \-\- +\fBregistration_virtual_networks\fP \-\- .sp A list of references to virtual networks that register hostnames in this DNS zone. This is only when zone_type is Private. (requires \fI\%azure\-mgmt\-dns\fP >= 2.0.0rc1) .IP \(bu 2 -\fBresolution_virtual_networks\fP \-\- +\fBresolution_virtual_networks\fP \-\- .sp A list of references to virtual networks that resolve records in this DNS zone. This is only when zone_type is Private. (requires \fI\%azure\-mgmt\-dns\fP >= 2.0.0rc1) @@ -372718,7 +372737,7 @@ Ensure a load balancer exists. .IP \(bu 2 \fBtags\fP \-\- A dictionary of strings can be passed as tag metadata to the load balancer object. .IP \(bu 2 -\fBfrontend_ip_configurations\fP \-\- +\fBfrontend_ip_configurations\fP \-\- .sp An optional list of dictionaries representing valid FrontendIPConfiguration objects. A frontend IP configuration can be either private (using private IP address and subnet parameters) or public (using a @@ -372743,7 +372762,7 @@ reference to a public IP address object). Valid parameters are: valid for a BackendAddressPool dictionary. All other parameters are read\-only references from other objects linking to the backend address pool. Inbound traffic is randomly load balanced across IPs in the backend IPs. .IP \(bu 2 -\fBprobes\fP \-\- +\fBprobes\fP \-\- .sp An optional list of dictionaries representing valid Probe objects. Valid parameters are: .INDENT 2.0 @@ -372769,7 +372788,7 @@ set to \(aqHttp\(aq. Otherwise, it is not allowed. There is no default value. .UNINDENT .IP \(bu 2 -\fBload_balancing_rules\fP \-\- +\fBload_balancing_rules\fP \-\- .sp An optional list of dictionaries representing valid LoadBalancingRule objects. Valid parameters are: .INDENT 2.0 @@ -372805,7 +372824,7 @@ Inbound traffic is randomly load balanced across IPs in the backend IPs. .UNINDENT .IP \(bu 2 -\fBinbound_nat_rules\fP \-\- +\fBinbound_nat_rules\fP \-\- .sp An optional list of dictionaries representing valid InboundNatRule objects. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from @@ -372834,7 +372853,7 @@ Availability Groups in SQL server. This setting can\(aqt be changed after you cr .UNINDENT .IP \(bu 2 -\fBinbound_nat_pools\fP \-\- +\fBinbound_nat_pools\fP \-\- .sp An optional list of dictionaries representing valid InboundNatPool objects. They define an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created @@ -372862,7 +372881,7 @@ provide Inbound NAT to NICs associated with a load balancer. Acceptable values r .UNINDENT .IP \(bu 2 -\fBoutbound_nat_rules\fP \-\- +\fBoutbound_nat_rules\fP \-\- .sp An optional list of dictionaries representing valid OutboundNatRule objects. Valid parameters are: .INDENT 2.0 @@ -372976,7 +372995,7 @@ minimum. At least one IP Configuration must be present. .IP \(bu 2 \fBvirtual_machine\fP \-\- The name of the existing virtual machine to assign to the network interface. .IP \(bu 2 -\fBdns_settings\fP \-\- +\fBdns_settings\fP \-\- .sp An optional dictionary representing a valid NetworkInterfaceDnsSettings object. Valid parameters are: .INDENT 2.0 @@ -373878,7 +373897,7 @@ Ensure a security policy definition exists. structure. One of \fBpolicy_rule\fP, \fBpolicy_rule_json\fP, or \fBpolicy_rule_file\fP is required, in that order of precedence for use if multiple parameters are used. .IP \(bu 2 -\fBpolicy_rule_json\fP \-\- +\fBpolicy_rule_json\fP \-\- .sp A text field defining the entirety of a policy definition in JSON. See \fI\%Azure Policy Definition documentation\fP for details on the structure. One of \fBpolicy_rule\fP, \fBpolicy_rule_json\fP, or \fBpolicy_rule_file\fP is required, in that order of @@ -373886,7 +373905,7 @@ precedence for use if multiple parameters are used. Note that the \fIname\fP fie \fBname\fP parameter in the state. .IP \(bu 2 -\fBpolicy_rule_file\fP \-\- +\fBpolicy_rule_file\fP \-\- .sp The source of a JSON file defining the entirety of a policy definition. See \fI\%Azure Policy Definition documentation\fP for @@ -376705,7 +376724,7 @@ the following characters: a\-z (lowercase), 0\-9, and \- (hyphen). \fBelasticsearch_version\fP (\fI\%str\fP) \-\- String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". .IP \(bu 2 -\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- +\fBelasticsearch_cluster_config\fP (\fI\%dict\fP) \-\- .sp Dict specifying the configuration options for an Elasticsearch domain. @@ -376739,7 +376758,7 @@ active and on standby, for the cluster. .UNINDENT .IP \(bu 2 -\fBebs_options\fP (\fI\%dict\fP) \-\- +\fBebs_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the options to enable or disable and specifying the type and size of EBS storage volumes. @@ -376758,7 +376777,7 @@ Iops (int): Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). .IP \(bu 2 \fBaccess_policies\fP (\fI\%str\fP\fI or \fP\fI\%dict\fP) \-\- Dict or JSON string with the IAM access policy. .IP \(bu 2 -\fBsnapshot_options\fP (\fI\%dict\fP) \-\- +\fBsnapshot_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the snapshot options. Keys (case senstive) in here are: @@ -376770,7 +376789,7 @@ Elasticsearch domain. Default value is 0 hours. .UNINDENT .IP \(bu 2 -\fBvpc_options\fP (\fI\%dict\fP) \-\- +\fBvpc_options\fP (\fI\%dict\fP) \-\- .sp Dict with the options to specify the subnets and security groups for the VPC endpoint. @@ -376783,7 +376802,7 @@ SecurityGroupIds (list): The list of security groups for the VPC endpoint. .UNINDENT .IP \(bu 2 -\fBcognito_options\fP (\fI\%dict\fP) \-\- +\fBcognito_options\fP (\fI\%dict\fP) \-\- .sp Dict with options to specify the cognito user and identity pools for Kibana authentication. @@ -376801,7 +376820,7 @@ for accessing Cognito resources. .UNINDENT .IP \(bu 2 -\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\- +\fBencryption_at_rest_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the encryption at rest options. This option can only be used for the creation of a new Elasticsearch @@ -376815,7 +376834,7 @@ KmsKeyId (str): Specifies the KMS Key ID for Encryption At Rest options. .UNINDENT .IP \(bu 2 -\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\- +\fBnode_to_node_encryption_options\fP (\fI\%dict\fP) \-\- .sp Dict specifying the node to node encryption options. This option can only be used for the creation of @@ -376833,7 +376852,7 @@ sub\-resources. By default, the value is True. See \fI\%http://docs.aws.amazon.com/elasticsearch\-service/latest/developerguide\fP /es\-createupdatedomains.html#es\-createdomain\-configure\-advanced\-options for more information. .IP \(bu 2 -\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- +\fBlog_publishing_options\fP (\fI\%dict\fP) \-\- .sp Dict with options for various type of logs. The keys denote the type of log file and can be one of the following: @@ -386719,7 +386738,7 @@ default arguments. Default is False. .IP \(bu 2 \fBpackage_args\fP (\fI\%str\fP) \-\- Arguments you want to pass to the package. Default is None. .IP \(bu 2 -\fBallow_multiple\fP (\fI\%bool\fP) \-\- +\fBallow_multiple\fP (\fI\%bool\fP) \-\- .sp Allow mulitiple versions of the package to be installed. Do not use with \fBforce\fP\&. Does not work with all packages. Default is False. @@ -400080,7 +400099,7 @@ New in version 2016.11.0. .IP \(bu 2 \fBname\fP \-\- The filesystem path to the directory containing backups to be managed. .IP \(bu 2 -\fBretain\fP \-\- +\fBretain\fP \-\- .sp Delete the backups, except for the ones we want to keep. The N below should be an integer but may also be the special value of \fBall\fP, @@ -409511,7 +409530,7 @@ ldapi:///: \fBconnect_spec\fP is either a connection object or a dict with a \fB\(aqurl\(aq\fP entry. .IP \(bu 2 -\fBentries\fP \-\- +\fBentries\fP \-\- .sp A description of the desired state of zero or more LDAP entries. @@ -421981,7 +422000,7 @@ Currently supported for the following pkg providers: either "pkgs" is used. Additionally, please note that this option can only be used to download packages from a software repository. .IP \(bu 2 -\fBversion\fP (\fI\%str\fP) \-\- +\fBversion\fP (\fI\%str\fP) \-\- .sp Download a specific version of a package. .sp @@ -422030,7 +422049,7 @@ common_packages: .UNINDENT .IP \(bu 2 -\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- +\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- .sp Turn on resolving capabilities. This allow one to name "provides" or alias names for packages. .sp @@ -422166,7 +422185,7 @@ option can only be used to install packages from a software repository. To install a package file manually, use the "sources" option detailed below. .IP \(bu 2 -\fBversion\fP (\fI\%str\fP) \-\- +\fBversion\fP (\fI\%str\fP) \-\- .sp Install a specific version of a package. This option is ignored if "sources" is used. Currently, this option is supported @@ -422300,7 +422319,7 @@ packages and figure out which of them match the specified wildcard expression. .IP \(bu 2 -\fBrefresh\fP (\fI\%bool\fP) \-\- +\fBrefresh\fP (\fI\%bool\fP) \-\- .sp This parameter controls whether or not the package repo database is updated prior to installing the requested package(s). @@ -422320,7 +422339,7 @@ will be performed for \fBpkg\fP states which do not explicitly set from slowing down the Salt run. .IP \(bu 2 -\fBcache_valid_time\fP (\fI\%str\fP) \-\- +\fBcache_valid_time\fP (\fI\%str\fP) \-\- .sp New in version 2016.11.0. @@ -422362,7 +422381,7 @@ has no effect on the rest. .UNINDENT .IP \(bu 2 -\fBfromrepo\fP (\fI\%str\fP) \-\- +\fBfromrepo\fP (\fI\%str\fP) \-\- .sp Specify a repository from which to install .sp @@ -422435,7 +422454,7 @@ release name is the part before the slash, so to install version .IP \(bu 2 \fBskip_verify\fP (\fI\%bool\fP) \-\- Skip the GPG verification check for the package to be installed .IP \(bu 2 -\fBskip_suggestions\fP (\fI\%bool\fP) \-\- +\fBskip_suggestions\fP (\fI\%bool\fP) \-\- .sp Force strict package naming. Disables lookup of package alternatives. .sp @@ -422443,7 +422462,7 @@ New in version 2014.1.1. .IP \(bu 2 -\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- +\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- .sp Turn on resolving capabilities. This allow one to name "provides" or alias names for packages. .sp @@ -422451,7 +422470,7 @@ New in version 2018.3.0. .IP \(bu 2 -\fBallow_updates\fP (\fI\%bool\fP) \-\- +\fBallow_updates\fP (\fI\%bool\fP) \-\- .sp Allow the package to be updated outside Salt\(aqs control (e.g. auto updates on Windows). This means a package on the Minion can have a @@ -422482,7 +422501,7 @@ httpd: .UNINDENT .IP \(bu 2 -\fBpkg_verify\fP (\fI\%bool\fP) \-\- +\fBpkg_verify\fP (\fI\%bool\fP) \-\- .sp New in version 2014.7.0. @@ -422553,7 +422572,7 @@ mypkgs: .UNINDENT .IP \(bu 2 -\fBignore_types\fP (\fI\%list\fP) \-\- +\fBignore_types\fP (\fI\%list\fP) \-\- .sp List of types to ignore when verifying the package .sp @@ -422561,7 +422580,7 @@ New in version 2014.7.0. .IP \(bu 2 -\fBverify_options\fP (\fI\%list\fP) \-\- +\fBverify_options\fP (\fI\%list\fP) \-\- .sp List of additional options to pass when verifying the package. These options will be added to the \fBrpm \-V\fP command, prepended with \fB\-\-\fP @@ -422572,7 +422591,7 @@ New in version 2016.11.0. .IP \(bu 2 -\fBnormalize\fP (\fI\%bool\fP) \-\- +\fBnormalize\fP (\fI\%bool\fP) \-\- .sp Normalize the package name by removing the architecture, if the architecture of the package is different from the architecture of the @@ -422599,7 +422618,7 @@ gpfs.gplbin\-2.6.32\-279.31.1.el6.x86_64: .UNINDENT .IP \(bu 2 -\fBignore_epoch\fP (\fI\%bool\fP) \-\- +\fBignore_epoch\fP (\fI\%bool\fP) \-\- .sp If this option is not explicitly set, and there is no epoch in the desired package version, the epoch will be implicitly ignored. Set this @@ -422626,7 +422645,7 @@ epochs unless this argument was set to \fBTrue\fP\&. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpkgs\fP (\fI\%list\fP) \-\- +\fBpkgs\fP (\fI\%list\fP) \-\- .sp A list of packages to install from a software repository. All packages listed under \fBpkgs\fP will be installed via a single command. @@ -422715,7 +422734,7 @@ mypkgs: .UNINDENT .IP \(bu 2 -\fBsources\fP (\fI\%list\fP) \-\- +\fBsources\fP (\fI\%list\fP) \-\- .sp A list of packages to install, along with the source URI or local path from which to install each package. In the example below, \fBfoo\fP, @@ -422751,7 +422770,7 @@ module for your OS, it is ignored. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhold\fP (\fI\%bool\fP) \-\- +\fBhold\fP (\fI\%bool\fP) \-\- .sp Force the package to be held at the current installed version. .sp @@ -422766,7 +422785,7 @@ New in version 3003. .IP \(bu 2 -\fBupdate_holds\fP (\fI\%bool\fP) \-\- +\fBupdate_holds\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP, and this function would update the package version, any packages which are being held will be temporarily unheld so that they @@ -422785,7 +422804,7 @@ New in version 3003. .IP \(bu 2 -\fBnames\fP (\fI\%list\fP) \-\- +\fBnames\fP (\fI\%list\fP) \-\- .sp A list of packages to install from a software repository. Each package will be installed individually by the package manager. @@ -422803,7 +422822,7 @@ features and the performance improvement that it brings. .UNINDENT .IP \(bu 2 -\fBinstall_recommends\fP (\fI\%bool\fP) \-\- +\fBinstall_recommends\fP (\fI\%bool\fP) \-\- .sp Whether to install the packages marked as recommended. Default is \fBTrue\fP\&. Currently only works with APT\-based systems. @@ -422824,7 +422843,7 @@ httpd: .UNINDENT .IP \(bu 2 -\fBonly_upgrade\fP (\fI\%bool\fP) \-\- +\fBonly_upgrade\fP (\fI\%bool\fP) \-\- .sp Only upgrade the packages, if they are already installed. Default is \fBFalse\fP\&. Currently only works with APT\-based systems. @@ -422853,7 +422872,7 @@ installed, the state will fail. .UNINDENT .IP \(bu 2 -\fBreport_reboot_exit_codes\fP (\fI\%bool\fP) \-\- +\fBreport_reboot_exit_codes\fP (\fI\%bool\fP) \-\- .sp If the installer exits with a recognized exit code indicating that a reboot is required, the module function @@ -423566,7 +423585,7 @@ list of packages to upgrade .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcache_valid_time\fP (\fI\%str\fP) \-\- +\fBcache_valid_time\fP (\fI\%str\fP) \-\- .sp This parameter sets the value in seconds after which cache marked as invalid, and cache update is necessary. This overwrite \fBrefresh\fP parameter @@ -423584,7 +423603,7 @@ have no effect on the rest. .UNINDENT .IP \(bu 2 -\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- +\fBresolve_capabilities\fP (\fI\%bool\fP) \-\- .sp Turn on resolving capabilities. This allow one to name "provides" or alias names for packages. .sp @@ -427099,7 +427118,7 @@ Ensure a registry value is removed. To remove a key use key_absent. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp A string value representing the full path of the key to include the HIVE, Key, and all Subkeys. For example: @@ -427171,7 +427190,7 @@ value entries. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp A string representing the full path to the key to be removed to include the hive and the keypath. The hive can be any of the @@ -427242,7 +427261,7 @@ Ensure a registry key or value is present. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp A string value representing the full path of the key to include the HIVE, Key, and all Subkeys. For example: @@ -427268,7 +427287,7 @@ HKEY_USERS or HKU parameter is not passed it will assume you want to set the \fB(Default)\fP value .IP \(bu 2 -\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\- +\fBvdata\fP (\fI\%str\fP\fI, \fP\fI\%int\fP\fI, \fP\fI\%list\fP\fI, \fP\fI\%bytes\fP) \-\- .sp The value you\(aqd like to set. If a value name (\fBvname\fP) is passed, this will be the data for that value name. If not, this will be the @@ -427325,7 +427344,7 @@ will be created with no associated item/value pairs. .UNINDENT .IP \(bu 2 -\fBvtype\fP (\fI\%str\fP) \-\- +\fBvtype\fP (\fI\%str\fP) \-\- .sp The value type for the data you wish to store in the registry. Valid values are: @@ -427352,7 +427371,7 @@ REG_SZ (Default) \fBuse_32bit_registry\fP (\fI\%bool\fP) \-\- Use the 32bit portion of the registry. Applies only to 64bit windows. 32bit Windows will ignore this parameter. Default is False. .IP \(bu 2 -\fBwin_owner\fP (\fI\%str\fP) \-\- +\fBwin_owner\fP (\fI\%str\fP) \-\- .sp The owner of the registry key. If this is not passed, the account under which Salt is running will be used. @@ -427369,7 +427388,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBwin_perms\fP (\fI\%dict\fP) \-\- +\fBwin_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing permissions to grant and their propagation. If not passed the \(aqGrant\(ga permissions will not be modified. @@ -427455,7 +427474,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBwin_deny_perms\fP (\fI\%dict\fP) \-\- +\fBwin_deny_perms\fP (\fI\%dict\fP) \-\- .sp A dictionary containing permissions to deny and their propagation. If not passed the \fIDeny\fP permissions will not be modified. @@ -427485,7 +427504,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBwin_inheritance\fP (\fI\%bool\fP) \-\- +\fBwin_inheritance\fP (\fI\%bool\fP) \-\- .sp \fBTrue\fP to inherit permissions from the parent key. \fBFalse\fP to disable inheritance. Default is \fBTrue\fP\&. @@ -427502,7 +427521,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBwin_perms_reset\fP (\fI\%bool\fP) \-\- +\fBwin_perms_reset\fP (\fI\%bool\fP) \-\- .sp If \fBTrue\fP the existing DACL will be cleared and replaced with the settings defined in this function. If \fBFalse\fP, new entries will be @@ -433705,7 +433724,7 @@ New in version 3001. .IP \(bu 2 \fBname\fP \-\- name of the virtual machine to run .IP \(bu 2 -\fBcpu\fP \-\- +\fBcpu\fP \-\- .sp Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is @@ -433830,7 +433849,7 @@ New in version 3003. .IP \(bu 2 -\fBmem\fP \-\- +\fBmem\fP \-\- .sp Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP, @@ -433916,7 +433935,7 @@ Only used when creating a new virtual machine. \fBarch\fP \-\- architecture of the virtual machine. The default value is taken from the host capabilities, but \fBx86_64\fP is prefed over \fBi686\fP\&. Only used when creating a new virtual machine. .IP \(bu 2 -\fBboot\fP \-\- +\fBboot\fP \-\- .sp Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine. This is an optional parameter, all of the keys are optional within the dictionary. @@ -433930,7 +433949,7 @@ New in version 3000. .IP \(bu 2 -\fBboot_dev\fP \-\- +\fBboot_dev\fP \-\- .sp Space separated list of devices to boot from sorted by decreasing priority. Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&. @@ -433941,7 +433960,7 @@ New in version 3002. .IP \(bu 2 -\fBnumatune\fP \-\- +\fBnumatune\fP \-\- .sp The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process @@ -433965,7 +433984,7 @@ New in version 3003. .UNINDENT .IP \(bu 2 -\fBhypervisor_features\fP \-\- +\fBhypervisor_features\fP \-\- .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp @@ -433984,7 +434003,7 @@ hypervisor_features: .UNINDENT .IP \(bu 2 -\fBclock\fP \-\- +\fBclock\fP \-\- .sp Configure the guest clock. The value is a dictionary with the following keys: @@ -434036,7 +434055,7 @@ clock: .UNINDENT .IP \(bu 2 -\fBserials\fP \-\- +\fBserials\fP \-\- .sp Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. @@ -434045,7 +434064,7 @@ New in version 3003. .IP \(bu 2 -\fBconsoles\fP \-\- +\fBconsoles\fP \-\- .sp Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. @@ -434054,7 +434073,7 @@ New in version 3003. .IP \(bu 2 -\fBstop_on_reboot\fP \-\- +\fBstop_on_reboot\fP \-\- .sp If set to \fBTrue\fP the guest will stop instead of rebooting. This is specially useful when creating a virtual machine with an installation cdrom or @@ -434065,7 +434084,7 @@ New in version 3003. .IP \(bu 2 -\fBlive\fP \-\- +\fBlive\fP \-\- .sp If set to \fBFalse\fP the changes will not be applied live to the running instance, but will only apply at the next start. Note that reboot will not take those changes. @@ -434074,7 +434093,7 @@ New in version 3003. .IP \(bu 2 -\fBhost_devices\fP \-\- +\fBhost_devices\fP \-\- .sp List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fBnode_devices()\fP function. @@ -434201,7 +434220,7 @@ Defines a new network with specified arguments. .IP \(bu 2 \fBbridge\fP \-\- Bridge name .IP \(bu 2 -\fBforward\fP \-\- +\fBforward\fP \-\- .sp Forward mode(bridge, router, nat) .sp @@ -434209,7 +434228,7 @@ Changed in version 3003: a \fBNone\fP value creates an isolated network with no .IP \(bu 2 -\fBvport\fP \-\- +\fBvport\fP \-\- .sp Virtualport type (Default: \fB\(aqNone\(aq\fP) The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys. @@ -434232,7 +434251,7 @@ Changed in version 3003: possible dictionary value .IP \(bu 2 -\fBtag\fP \-\- +\fBtag\fP \-\- .sp Vlan tag (Default: \fB\(aqNone\(aq\fP) The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys. @@ -434277,7 +434296,7 @@ for more details on this dictionary. .IP \(bu 2 \fBpassword\fP \-\- password to connect with, overriding defaults .IP \(bu 2 -\fBmtu\fP \-\- +\fBmtu\fP \-\- .sp size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) @@ -434286,7 +434305,7 @@ New in version 3003. .IP \(bu 2 -\fBdomain\fP \-\- +\fBdomain\fP \-\- .sp DNS domain name of the DHCP server. The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one. @@ -434308,7 +434327,7 @@ New in version 3003. .IP \(bu 2 -\fBnat\fP \-\- +\fBnat\fP \-\- .sp addresses and ports to route in NAT forward mode. The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&. @@ -434336,7 +434355,7 @@ New in version 3003. .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp whitespace separated list of network interfaces devices that can be used for this network. (default \fBNone\fP) @@ -434356,7 +434375,7 @@ New in version 3003. .IP \(bu 2 -\fBaddresses\fP \-\- +\fBaddresses\fP \-\- .sp whitespace separated list of addreses of PCI devices that can be used for this network in \fIhostdev\fP forward mode. (default \fBNone\fP) @@ -434376,7 +434395,7 @@ New in version 3003. .IP \(bu 2 -\fBphysical_function\fP \-\- +\fBphysical_function\fP \-\- .sp device name of the physical interface to use in \fBhostdev\fP forward mode. (default \fBNone\fP) @@ -434396,7 +434415,7 @@ New in version 3003. .IP \(bu 2 -\fBdns\fP \-\- +\fBdns\fP \-\- .sp virtual network DNS configuration The value is a dictionary described in net\-define\-dns\&. @@ -434502,7 +434521,7 @@ Defines and starts a new network with specified arguments. .IP \(bu 2 \fBbridge\fP \-\- Bridge name .IP \(bu 2 -\fBforward\fP \-\- +\fBforward\fP \-\- .sp Forward mode(bridge, router, nat) .sp @@ -434510,7 +434529,7 @@ Changed in version 3003: a \fBNone\fP value creates an isolated network with no .IP \(bu 2 -\fBvport\fP \-\- +\fBvport\fP \-\- .sp Virtualport type (Default: \fB\(aqNone\(aq\fP) The value can also be a dictionary with \fBtype\fP and \fBparameters\fP keys. @@ -434533,7 +434552,7 @@ Changed in version 3003: possible dictionary value .IP \(bu 2 -\fBtag\fP \-\- +\fBtag\fP \-\- .sp Vlan tag (Default: \fB\(aqNone\(aq\fP) The value can also be a dictionary with the \fBtags\fP and optional \fBtrunk\fP keys. @@ -434560,7 +434579,7 @@ Changed in version 3003: possible dictionary value .IP \(bu 2 -\fBipv4_config\fP \-\- +\fBipv4_config\fP \-\- .sp IPv4 network configuration. See the :py:func\(gavirt.network_define \(ga function corresponding parameter documentation @@ -434571,7 +434590,7 @@ New in version 3000. .IP \(bu 2 -\fBipv6_config\fP \-\- +\fBipv6_config\fP \-\- .sp IPv6 network configuration. See the :py:func\(gavirt.network_define \(ga function corresponding parameter documentation @@ -434584,7 +434603,7 @@ New in version 3000. .IP \(bu 2 \fBautostart\fP \-\- Network autostart (default \fB\(aqTrue\(aq\fP) .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -434592,7 +434611,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -434600,7 +434619,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -434608,7 +434627,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBmtu\fP \-\- +\fBmtu\fP \-\- .sp size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) @@ -434617,7 +434636,7 @@ New in version 3003. .IP \(bu 2 -\fBdomain\fP \-\- +\fBdomain\fP \-\- .sp DNS domain name of the DHCP server. The value is a dictionary with a mandatory \fBname\fP property and an optional \fBlocalOnly\fP boolean one. @@ -434639,7 +434658,7 @@ New in version 3003. .IP \(bu 2 -\fBnat\fP \-\- +\fBnat\fP \-\- .sp addresses and ports to route in NAT forward mode. The value is a dictionary with optional keys \fBaddress\fP and \fBport\fP\&. @@ -434667,7 +434686,7 @@ New in version 3003. .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp whitespace separated list of network interfaces devices that can be used for this network. (default \fBNone\fP) @@ -434687,7 +434706,7 @@ New in version 3003. .IP \(bu 2 -\fBaddresses\fP \-\- +\fBaddresses\fP \-\- .sp whitespace separated list of addreses of PCI devices that can be used for this network in \fIhostdev\fP forward mode. (default \fBNone\fP) @@ -434707,7 +434726,7 @@ New in version 3003. .IP \(bu 2 -\fBphysical_function\fP \-\- +\fBphysical_function\fP \-\- .sp device name of the physical interface to use in \fBhostdev\fP forward mode. (default \fBNone\fP) @@ -434727,7 +434746,7 @@ New in version 3003. .IP \(bu 2 -\fBdns\fP \-\- +\fBdns\fP \-\- .sp virtual network DNS configuration The value is a dictionary described in net\-define\-dns\&. @@ -435000,7 +435019,7 @@ New in version 2016.3.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -435008,7 +435027,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -435016,7 +435035,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -435049,9 +435068,9 @@ New in version 2016.3.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP \-\- +\fBname\fP \-\- .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -435059,7 +435078,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -435067,7 +435086,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -435119,7 +435138,7 @@ New in version 2016.3.0. .IP \(bu 2 \fBname\fP \-\- name of the virtual machine to run .IP \(bu 2 -\fBcpu\fP \-\- +\fBcpu\fP \-\- .sp Number of virtual CPUs to assign to the virtual machine or a dictionary with detailed information to configure cpu model and topology, numa node tuning, cpu tuning and iothreads allocation. The structure of the dictionary is @@ -435130,7 +435149,7 @@ specify \fBNone\fP object. Please note that \fBNone\fP object is mapped to \fBnu instead. .IP \(bu 2 -\fBmem\fP \-\- +\fBmem\fP \-\- .sp Amount of memory to allocate to the virtual machine in MiB. Since 3002, a dictionary can be used to contain detailed configuration which support memory allocation or tuning. Supported parameters are \fBboot\fP, @@ -435158,7 +435177,7 @@ Changed in version 3002. .IP \(bu 2 -\fBvm_type\fP \-\- +\fBvm_type\fP \-\- .sp force virtual machine type for the new VM. The default value is taken from the host capabilities. This could be useful for example to use \fB\(aqqemu\(aq\fP type instead @@ -435168,7 +435187,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBdisk_profile\fP \-\- +\fBdisk_profile\fP \-\- .sp Name of the disk profile to use for the new virtual machine .sp @@ -435176,7 +435195,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBdisks\fP \-\- +\fBdisks\fP \-\- .sp List of disk to create for the new virtual machine. See init\-disk\-def for more details on the items on this list. @@ -435185,7 +435204,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBnic_profile\fP \-\- +\fBnic_profile\fP \-\- .sp Name of the network interfaces profile to use for the new virtual machine .sp @@ -435193,7 +435212,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBinterfaces\fP \-\- +\fBinterfaces\fP \-\- .sp List of network interfaces to create for the new virtual machine. See init\-nic\-def for more details on the items on this list. @@ -435202,7 +435221,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBgraphics\fP \-\- +\fBgraphics\fP \-\- .sp Graphics device to create for the new virtual machine. See init\-graphics\-def for more details on this dictionary @@ -435211,7 +435230,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBsaltenv\fP \-\- +\fBsaltenv\fP \-\- .sp Fileserver environment (Default: \fB\(aqbase\(aq\fP). See \fBcp module for more details\fP @@ -435230,7 +435249,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBinstall\fP \-\- +\fBinstall\fP \-\- .sp install salt minion if absent (Default: \fBTrue\fP) .sp @@ -435238,7 +435257,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpub_key\fP \-\- +\fBpub_key\fP \-\- .sp public key to seed with (Default: \fBNone\fP) .sp @@ -435246,7 +435265,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpriv_key\fP \-\- +\fBpriv_key\fP \-\- .sp public key to seed with (Default: \fBNone\fP) .sp @@ -435254,7 +435273,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBseed_cmd\fP \-\- +\fBseed_cmd\fP \-\- .sp Salt command to execute to seed the image. (Default: \fB\(aqseed.apply\(aq\fP) .sp @@ -435262,7 +435281,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -435270,7 +435289,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -435278,7 +435297,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -435286,7 +435305,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBos_type\fP \-\- +\fBos_type\fP \-\- .sp type of virtualization as found in the \fB//os/type\fP element of the libvirt definition. The default value is taken from the host capabilities, with a preference for \fBhvm\fP\&. @@ -435296,7 +435315,7 @@ New in version 3000. .IP \(bu 2 -\fBarch\fP \-\- +\fBarch\fP \-\- .sp architecture of the virtual machine. The default value is taken from the host capabilities, but \fBx86_64\fP is prefed over \fBi686\fP\&. Only used when creating a new virtual machine. @@ -435305,7 +435324,7 @@ New in version 3000. .IP \(bu 2 -\fBboot\fP \-\- +\fBboot\fP \-\- .sp Specifies kernel, initial ramdisk and kernel command line parameters for the virtual machine. This is an optional parameter, all of the keys are optional within the dictionary. @@ -435319,7 +435338,7 @@ New in version 3000. .IP \(bu 2 -\fBserials\fP \-\- +\fBserials\fP \-\- .sp Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. @@ -435328,7 +435347,7 @@ New in version 3003. .IP \(bu 2 -\fBconsoles\fP \-\- +\fBconsoles\fP \-\- .sp Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. @@ -435337,7 +435356,7 @@ New in version 3003. .IP \(bu 2 -\fBboot_dev\fP \-\- +\fBboot_dev\fP \-\- .sp Space separated list of devices to boot from sorted by decreasing priority. Values can be \fBhd\fP, \fBfd\fP, \fBcdrom\fP or \fBnetwork\fP\&. @@ -435348,7 +435367,7 @@ New in version 3002. .IP \(bu 2 -\fBnumatune\fP \-\- +\fBnumatune\fP \-\- .sp The optional numatune element provides details of how to tune the performance of a NUMA host via controlling NUMA policy for domain process. The optional \fBmemory\fP element specifies how to allocate memory for the domain process @@ -435363,7 +435382,7 @@ New in version 3003. .IP \(bu 2 -\fBstop_on_reboot\fP \-\- +\fBstop_on_reboot\fP \-\- .sp If set to \fBTrue\fP the guest will stop instead of rebooting. This is specially useful when creating a virtual machine with an installation cdrom or @@ -435374,7 +435393,7 @@ New in version 3003. .IP \(bu 2 -\fBhypervisor_features\fP \-\- +\fBhypervisor_features\fP \-\- .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp @@ -435393,7 +435412,7 @@ hypervisor_features: .UNINDENT .IP \(bu 2 -\fBclock\fP \-\- +\fBclock\fP \-\- .sp Configure the guest clock. The value is a dictionary with the following keys: @@ -435445,7 +435464,7 @@ clock: .UNINDENT .IP \(bu 2 -\fBhost_devices\fP \-\- +\fBhost_devices\fP \-\- .sp List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fBnode_devices()\fP function. @@ -435548,7 +435567,7 @@ New in version 2016.3.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -435556,7 +435575,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -435564,7 +435583,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -435602,7 +435621,7 @@ New in version 2016.3.0. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBconnection\fP \-\- +\fBconnection\fP \-\- .sp libvirt connection URI, overriding defaults .sp @@ -435610,7 +435629,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBusername\fP \-\- +\fBusername\fP \-\- .sp username to connect with, overriding defaults .sp @@ -435618,7 +435637,7 @@ New in version 2019.2.0. .IP \(bu 2 -\fBpassword\fP \-\- +\fBpassword\fP \-\- .sp password to connect with, overriding defaults .sp @@ -435687,7 +435706,7 @@ By default, the type is guessed by libvirt from the pool type. \fBpermissions\fP \-\- Permissions to set on the target folder. This is mostly used for filesystem\-based pool types. See pool\-define\-permissions for more details on this structure. .IP \(bu 2 -\fBbacking_store\fP \-\- +\fBbacking_store\fP \-\- .sp dictionary describing a backing file for the volume. It must contain a \fBpath\fP property pointing to the base volume and a \fBformat\fP property defining the format @@ -436435,7 +436454,7 @@ Required. 0 and 65535. Can be a range. Can specify multiple ports separated by commas. Required. .IP \(bu 2 -\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprotocol\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The protocol. Can be any of the following: .INDENT 2.0 @@ -436454,7 +436473,7 @@ any .UNINDENT .IP \(bu 2 -\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBaction\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The action the rule performs. Can be any of the following: @@ -436470,7 +436489,7 @@ bypass .IP \(bu 2 \fBdir\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- The direction. Can be \fBin\fP or \fBout\fP\&. .IP \(bu 2 -\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\- +\fBremoteip\fP (\fIOptional\fP\fI [\fP\fI\%str\fP\fI]\fP) \-\- .sp The remote IP. Can be any of the following: .INDENT 2.0 @@ -436530,7 +436549,7 @@ Disable all the firewall profiles (Windows only) .INDENT 7.0 .TP .B Parameters -\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the profile to disable. Default is \fBallprofiles\fP\&. Valid options are: @@ -436574,7 +436593,7 @@ Enable all the firewall profiles (Windows only) .INDENT 7.0 .TP .B Parameters -\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBprofile\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the profile to enable. Default is \fBallprofiles\fP\&. Valid options are: @@ -438028,7 +438047,7 @@ Set the sleep timeouts of specific items such as disk, monitor, etc. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp The setting to change, can be one of the following: .INDENT 2.0 @@ -438049,7 +438068,7 @@ The setting to change, can be one of the following: .IP \(bu 2 \fBvalue\fP (\fI\%int\fP) \-\- The amount of time in minutes before the item will timeout .IP \(bu 2 -\fBpower\fP (\fI\%str\fP) \-\- +\fBpower\fP (\fI\%str\fP) \-\- .sp Set the value for AC or DC power. Default is \fBac\fP\&. Valid options are: @@ -438065,7 +438084,7 @@ are: .UNINDENT .IP \(bu 2 -\fBscheme\fP (\fI\%str\fP) \-\- +\fBscheme\fP (\fI\%str\fP) \-\- .sp The scheme to use, leave as \fBNone\fP to use the current. Default is \fBNone\fP\&. This can be the GUID or the Alias for the Scheme. Known @@ -438144,7 +438163,7 @@ server is restarted other features can not be installed! .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp Short name of the feature (the right column in win_servermanager.list_available). This can be a single feature or a @@ -438160,7 +438179,7 @@ list .UNINDENT .IP \(bu 2 -\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\- +\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\- .sp A list of features to install. If this is passed it will be used instead of the \fBname\fP parameter. @@ -438183,7 +438202,7 @@ required files. Default is None \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Restarts the computer when installation is complete, if required by the role/feature installed. Default is False .IP \(bu 2 -\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- +\fBexclude\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The name of the feature to exclude when installing the named feature. This can be a single feature, a string of features in a @@ -438257,7 +438276,7 @@ parameter. To remove multiple features, use the \fBfeatures\fP parameter. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- +\fBname\fP (\fI\%str\fP) \-\- .sp Short name of the feature (the right column in win_servermanager.list_available). This can be a single feature or a @@ -438273,7 +438292,7 @@ list .UNINDENT .IP \(bu 2 -\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\- +\fBfeatures\fP (\fIOptional\fP\fI[\fP\fI\%list\fP\fI]\fP) \-\- .sp A list of features to remove. If this is passed it will be used instead of the \fBname\fP parameter. @@ -438783,7 +438802,7 @@ Reboot the computer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- +\fBmessage\fP (\fI\%str\fP) \-\- .sp An optional message to display to users. It will also be used as a comment in the event log entry. @@ -438791,7 +438810,7 @@ comment in the event log entry. The default value is None. .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The number of minutes or seconds before a reboot will occur. Whether this number represents minutes or seconds depends on the value of @@ -438800,7 +438819,7 @@ this number represents minutes or seconds depends on the value of The default value is 5. .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp If this is True, the value of \fBtimeout\fP will be treated as a number of seconds. If this is False, the value of \fBtimeout\fP will be treated @@ -438809,7 +438828,7 @@ as a number of minutes. The default value is False. .IP \(bu 2 -\fBforce_close\fP (\fI\%bool\fP) \-\- +\fBforce_close\fP (\fI\%bool\fP) \-\- .sp If this is True, running applications will be forced to close without warning. If this is False, running applications will not get the @@ -438818,7 +438837,7 @@ opportunity to prompt users about unsaved data. The default value is True. .IP \(bu 2 -\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- +\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- .sp If this is True, the reboot will only occur if the system reports a pending reboot. If this is False, the reboot will always occur. @@ -438837,7 +438856,7 @@ Shutdown the computer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- +\fBmessage\fP (\fI\%str\fP) \-\- .sp An optional message to display to users. It will also be used as a comment in the event log entry. @@ -438845,7 +438864,7 @@ comment in the event log entry. The default value is None. .IP \(bu 2 -\fBtimeout\fP (\fI\%int\fP) \-\- +\fBtimeout\fP (\fI\%int\fP) \-\- .sp The number of minutes or seconds before a shutdown will occur. Whether this number represents minutes or seconds depends on the value of @@ -438854,7 +438873,7 @@ this number represents minutes or seconds depends on the value of The default value is 5. .IP \(bu 2 -\fBin_seconds\fP (\fI\%bool\fP) \-\- +\fBin_seconds\fP (\fI\%bool\fP) \-\- .sp If this is True, the value of \fBtimeout\fP will be treated as a number of seconds. If this is False, the value of \fBtimeout\fP will be treated @@ -438863,7 +438882,7 @@ as a number of minutes. The default value is False. .IP \(bu 2 -\fBforce_close\fP (\fI\%bool\fP) \-\- +\fBforce_close\fP (\fI\%bool\fP) \-\- .sp If this is True, running applications will be forced to close without warning. If this is False, running applications will not get the @@ -438872,7 +438891,7 @@ opportunity to prompt users about unsaved data. The default value is True. .IP \(bu 2 -\fBreboot\fP (\fI\%bool\fP) \-\- +\fBreboot\fP (\fI\%bool\fP) \-\- .sp If this is True, the computer will restart immediately after shutting down. If False the system flushes all caches to disk and safely powers @@ -438881,7 +438900,7 @@ down the system. The default value is False. .IP \(bu 2 -\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- +\fBonly_on_pending_reboot\fP (\fI\%bool\fP) \-\- .sp If this is True, the shutdown will only occur if the system reports a pending reboot. If this is False, the shutdown will always occur. @@ -439154,7 +439173,7 @@ reference .IP \(bu 2 \fBskip_reboot\fP (\fI\%bool\fP) \-\- Skip updates that require a reboot. Default is True. .IP \(bu 2 -\fBcategories\fP (\fI\%list\fP) \-\- +\fBcategories\fP (\fI\%list\fP) \-\- .sp Specify the categories to list. Must be passed as a list. All categories returned by default. @@ -439190,7 +439209,7 @@ Windows Defender .UNINDENT .IP \(bu 2 -\fBseverities\fP (\fI\%list\fP) \-\- +\fBseverities\fP (\fI\%list\fP) \-\- .sp Specify the severities to include. Must be passed as a list. All severities returned by default. @@ -441112,7 +441131,7 @@ installed2 .UNINDENT .INDENT 0.0 .TP -.B salt.states.zcbuildout.installed(name, config=\(aqbuildout.cfg\(aq, quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python=\(aq/mnt/c/Users/alyssar/Documents/Git\-Projects/salt\-priv/.nox/docs\-man\-compress\-false\-update\-true\-clean\-true/bin/python\(aq, debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel=\(aqdebug\(aq, **kwargs) +.B salt.states.zcbuildout.installed(name, config=\(aqbuildout.cfg\(aq, quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python=\(aq/home/ch3ll/git/salt/.nox/docs\-man\-compress\-false\-update\-true\-clean\-true/bin/python\(aq, debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel=\(aqdebug\(aq, **kwargs) Install buildout in a specific directory .sp It is a thin wrapper to modules.buildout.buildout @@ -445537,7 +445556,7 @@ used if no arguments are required. \fBtgt\fP (\fIstring\fP\fI or \fP\fI\%list\fP) \-\- Which minions to target for the execution. Default is shell glob. Modified by the \fBtgt_type\fP option. .IP \(bu 2 -\fBfun\fP (\fIstring\fP\fI or \fP\fIlist of strings\fP) \-\- +\fBfun\fP (\fIstring\fP\fI or \fP\fIlist of strings\fP) \-\- .sp The module and function to call on the specified minions of the form \fBmodule.function\fP\&. For example \fBtest.ping\fP or @@ -445563,7 +445582,7 @@ executing a compound command. \fBtimeout\fP \-\- Seconds to wait after the last minion returns but before all minions return. .IP \(bu 2 -\fBtgt_type\fP \-\- +\fBtgt_type\fP \-\- .sp The type of \fBtgt\fP\&. Allowed values: .INDENT 2.0 @@ -445604,7 +445623,7 @@ on the minions \fBfull_return\fP \-\- Output the job return only (default) or the full return including exit code and other job metadata. .IP \(bu 2 -\fBkwargs\fP \-\- +\fBkwargs\fP \-\- .sp Optional keyword arguments. Authentication credentials may be passed when using @@ -459581,11 +459600,11 @@ Sign authentication replies to prevent MiTM (cve\-2022\-22935) .IP \(bu 2 Prevent job and fileserver replays (cve\-2022\-22936) .IP \(bu 2 -Fix denial of service in junos ifconfig output parsing. (cve\-2022\-22937) -.IP \(bu 2 Sign pillar data to prevent MiTM attacks. (cve\-2202\-22934) .IP \(bu 2 Fixed targeting bug, especially visible when using syndic and user auth. (CVE\-2022\-22941) (#60413) +.IP \(bu 2 +Fix denial of service in junos ifconfig output parsing. .UNINDENT .SS Salt 3002 Release Notes \- Codename Magnesium .SS New Features diff --git a/doc/man/spm.1 b/doc/man/spm.1 index bc989d474610..8458790635ad 100644 --- a/doc/man/spm.1 +++ b/doc/man/spm.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SPM" "1" "Feb 25, 2022" "3003.4" "Salt" +.TH "SPM" "1" "May 24, 2022" "3003.5" "Salt" .SH NAME spm \- Salt Package Manager Command . diff --git a/doc/topics/releases/3003.5.rst b/doc/topics/releases/3003.5.rst new file mode 100644 index 000000000000..2e2462c79b2b --- /dev/null +++ b/doc/topics/releases/3003.5.rst @@ -0,0 +1,21 @@ +.. _release-3003-5: + +======================== +Salt 3003.5 (2022-07-05) +======================== + +Version 3003.5 is a CVE security fix release for :ref:`3003 `. + +Fixed +----- + +- Update Markup and contextfunction imports for jinja versions >=3.1. (#61848) +- Fix bug in tcp transport (#61865) +- Make sure the correct key is being used when verifying or validating communication, eg. when a Salt syndic is involved use syndic_master.pub and when a Salt minion is involved use minion_master.pub. (#61868) + + +Security +-------- + +- Fixed PAM auth to reject auth attempt if user account is locked. (cve-2022-22967) +