Commit Graph

126 Commits (78b003858d6dc261987db08798cd4d14c4e607da)

Author SHA1 Message Date
Pilou 7f41cc40e6 [doc] expect module: mention all parameter types (#56394) 2019-05-14 09:06:00 -05:00
Pilou 8968d41599 [doc] command module: mention all parameter types (#56396) 2019-05-14 08:50:49 -05:00
Sayed Anisul Hoque 9ff25c0167 Updated playbook works sample. (#51673)
<!--- Your description here -->

Removed `|` from the playbook works sample.

+label: docsite_pr
2019-03-11 17:12:05 -05:00
Sam Doran ad386290b4
Update command/shell docs with note about modules for rebooting(#51499)
- Update integration test syntax
2019-02-13 13:54:36 -05:00
Jordan Borean 0f0d33a954 start getting modules to use shared import error code (#51787) 2019-02-06 12:39:17 -05:00
Brian Coca 3ba3af5058
toggle for stripping empty shell/command output (#51342)
* toggle for stripping empty shell/command output

  fixes #45367

* Update lib/ansible/modules/commands/command.py

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>
2019-01-29 15:55:38 -05:00
Dag Wieers 6c6b088bde shell: Improve documentation (#51109)
* shell: Improve documentation

This PR includes:
- Adding parameter types
- General improvements

* Update lib/ansible/modules/commands/shell.py
2019-01-22 21:58:12 +01:00
Dag Wieers 2d890105f1
raw is transport-agnostic
+label: docsite_pr
2019-01-07 16:53:27 +01:00
Alicia Cozine 6fc4bb4a6d Command module docs: args vs argv (#49907)
* add note about 'args', update examples
* Update lib/ansible/modules/commands/command.py

Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
2018-12-19 13:30:05 -05:00
Dag Wieers 05c6ff79f9 Convert to reduced list of known types (#50010) 2018-12-19 07:25:30 +10:00
Dag Wieers 15d39f9108 Sanity fixes in various modules (#50080) 2018-12-18 09:53:46 -06:00
Dag Wieers 26474c6902
Add seealso section to Windows and related modules (#49845)
* Add seealso section to Windows and related modules

* Fixes after review
2018-12-15 03:23:59 +01:00
Jorgen 8ff13db17c Add Windows example of raw command (#47153)
* Add Windows example of raw command

Perform shutdown of Windows OS using Microsoft.PowerShell.Management module

* Capitalized cmdlet, remove quotes and improve description

This commit also cleans up some of the description sections.

* Use another example as suggested by jborean93

I was happy to merge this before I noticed jborean93 objected to the example :-/

* Fix whitespace issue
2018-11-30 17:12:19 +01:00
Abhijeet Kasurde bc3e7bbeba
E325 Removal - Part II (#49196)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-28 13:55:52 +05:30
James Cassell 8eacaf6a77 command modules: optional stdin_add_newline (#45170)
* stdin_add_newline: allow newline suppression on command modules

* command/shell: test for stdin_add_newline

* changelog for stdin_add_newline
2018-10-31 12:53:02 -04:00
Jordan Borean ddfd1dbfc6
Add helper function to return helpful import error msg (#47409) 2018-10-24 07:21:36 +10:00
Dag Wieers 6f9c6071e5 psexec: Handle socket errors (Connection timeout) (#47201)
* psexec: Handle socket errors (Connection timeout)

This ensures we get a nicer error message from psexec.

* Add changelog fragment
2018-10-22 05:32:06 +10:00
Jordan Borean 013c44484a psexec: better error on import failure (#47327) 2018-10-19 08:56:16 +02:00
Dag Wieers ff06320b03 Add less judgmental hint to use script + template 2018-09-28 19:19:58 +02:00
Dag Wieers 04de52da2c Clean up common module docs (#45888)
Some of the older modules have evolved documentation that does not
follow a consistent style. This is a clean-up in form and style.
2018-09-27 11:27:01 -04:00
Kerry bf90a44468 Clarify the creates and removes options (#45485)
* Clarify the creates and removes options

The description for the creates and removes options were worded poorly. This change improves readability and is easier to understand.

 Double negatives are BAD

+label: docsite_pr

* Fix trailing whitespace
2018-09-11 15:45:19 -05:00
Dag Wieers 86147d598f Various improvements to script module docs (#44637)
This PR includes:
- Use uppercase in descriptions
- Add trailing dot to descriptions
- Grammar/spelling fixes
- Adding names to examples as a best practice
- Simplify structure
2018-08-24 09:56:44 -04:00
Yuma Inaura (稲浦悠馬) 34c582287a Fix script module document (#42778)
script module seems does not create / remove files
it seems only checks file existence or not existence


+label: docsite_pr
2018-08-24 14:59:04 +02:00
Steve Dodd c89dfad846 Update shell.py (#44477)
* Update shell.py

<!--- Your description here -->
Add example for disabling warnings to shell module
+label: docsite_pr

* Fix PEP8 issues
2018-08-23 12:31:55 +10:00
Daniel-Sanchez-Fabregas 798dc4b438 In expect module documentation add `no_log` to password change example (#44436)
* Update expect.py

Recommend not showing passwords in the logs

+label: docsite_pr

* Fix unicode quotes
2018-08-21 08:42:41 -05:00
Matt Martz c1c229c6d4
Remove use of simplejson throughout code base (#43548)
* Remove use of simplejson throughout code base. Fixes #42761

* Address failing tests

* Remove simplejson from contrib and other outlying files

* Add changelog fragment for simplejson removal
2018-08-10 11:13:29 -05:00
Andrew Gaffney 9f9e936d3c Force all args to strings for 'command' (fixes #43732) 2018-08-06 14:27:45 -07:00
Jarryd Tilbrook 460f858640 Enable check_mode in command module (#40428)
* Enable check_mode in command module

This only works if supplying creates or removes since it needs
something to base the heuristic off. If none are supplied it will just
skip as usual.
Fixes #15828

* Add documentation for new check_mode behavior
2018-07-23 14:06:41 -07:00
Peter Sprygada d086d57d11 adds a new feature to the telnet action plugin
This change adds a new argument to the telnet action plugin that will
cause the module to send a newline character before trying to login.
This is convienent when using telnet over a console connection that
needs an initial newline character to start the login process.

This change also will cause the sent command and command response to be
displayed on stdout when running in verbose mode (5 v's).
2018-07-12 10:11:55 -04:00
tranceitionalMynd 04e3c964fb Added executable parameter to the script module (#36969)
* Added interpreter parameter to the script module

* Let required and default parameters get documented implicitly for binary parameter

* Renamed interpreter parameter to executable
2018-05-25 14:40:48 -05:00
Antoine Pietri 313a46744d Add a 'machinectl shell' become_method (#39826)
* Add a 'machinectl shell' become_method

* docs: add explanations for the machinectl become_method

* docs: machinectl become_method: specify this part is specific to Linux+systemd setups
2018-05-25 10:52:53 -05:00
Joshua Smith a40f6b7c1f Update examples in modules/commands to use proper YAML syntax. (#35692)
* Update examples to use proper YAML syntax.

* Fix syntax error.
2018-05-23 11:50:13 -05:00
Bruno Inec b845db0169 Explicit availability of 'null' timeout in expect (#40429) 2018-05-21 12:32:06 -05:00
Adam Patt 223a4c0685 Fixes #19392: allow commands to be specified as lists. new syntax is documented as well. (#40261)
* Fixes #19392: allow commands to be specified as lists.  new syntax is documented as well
2018-05-16 13:37:39 -07:00
Filippo Civiletti c32aef74d5 expect: Fix typo in examples (#39900) 2018-05-09 13:55:17 +02:00
Jordan Borean 629efb6eaa
psexec: new module to run commands on a remote Windows host without WinRM (#36723)
* psexec: new module to run commands on a remote Windows host without WinRM

* fix up sanity issue, create test firewall rule for SMB traffic

* Fixed up yaml linting issues, trying to fix on the fly firewall rule

* Added SMB exception to catch when cleaning up PAExec exe

* Don't load profile for Azure hosts when becoming another user

* Fixed up example to use correct option

* Reworded notes section of module docs

* Simplified module options around process integrity levels and the system account
2018-04-24 12:15:15 +10:00
Dag Wieers cdd21e2170
Clean up module documentation (#36909)
* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues
2018-03-15 22:15:24 +01:00
Sam Doran 5e7ee9df0a Add note to use script module rather than inline here documents (#32863)
* Add example on how to use a here document with shell module

* Remove here doc example and add note to use script module instead
2018-02-21 09:12:09 -05:00
Ken Celenza 669a86174f Update docs for telnet module (#35257) 2018-01-24 07:33:47 +00:00
Toshio Kuratomi 235bdfb996 Remove shell module specialcases
Shell is implemented via the command module.  There was a special case
in mod_args to do that.  Make shell into an action plugin to handle that
instead.

Also move the special case for the command nanny into a command module
action plugin.  This is more appropriate as we then do not have to send
a parameter that is only for the command module to every single module.
2017-12-21 20:42:44 -08:00
Brian Coca a0c171ce1b fix command warnings, add action warnings (#34060)
* fix command warnings, add action warnings
2017-12-21 08:35:32 -08:00
John R Barker 20174f1c47 Suggest using replace module rather than command sed (#34085)
* Suggest using replace module rather than command sed

* Better order
2017-12-20 10:00:32 -05:00
Toshio Kuratomi 2e1c889275
Have command nanny tell you how to disable the warning (#34061)
* Have command nanny tell you how to disable the warning
2017-12-19 17:30:10 -08:00
Toshio Kuratomi 824ec37a4f Fix Command module documentation
The command module docs were unclear.  They talked about ignoring the user's environment which lead people to believe the user's environment variables were not used.  In actual fact, the user's environment variables are used.  They just are not expanded in the command.
2017-12-08 10:07:00 -08:00
Sam Doran ea3638b580 Add proper check mode support to the script module (#31852)
* Do not run script in check mode

Fixes #30676

* Reformat script integration test

* Add integration tests for check mode of script module

* Fix name on test

* Cleanup temp file

* win_script integration test syntaxt changes

* Add check mode tests for win_script

* Use proper variable in test

* Fail if source file does not exist

* Verify script is accessible and don't copy in check mode

Use shlex to properly split shell arguments, though a path with spaces in it still needs to be quoted in the playbook.
Add note to docs describing such.
Improve error message if file is not found indicating there may be a space in the path.

* Properly encode path now that path is split using shlex

* Allow for spaces in both path and script name

* Add unicode character test to Linux script tests

* Add Linux test for space in path to script
2017-11-13 15:33:44 -08:00
Yeuk Hon Wong ef25367353 Fixes #30073: Remove 'Consider hg command' warning. (#31159)
This PR addresses two issues:

1. The hg module was added to command module's check_command list,
so if someone runs hg directly from the command module, the command
module would warn the user "Consider using hg module rather than running hg".

We address this by removing hg from the list.

2. We added a new note to tell users push feature will be addressed
in issue #31156.
2017-10-02 23:33:13 +02:00
Prasad Katti 4b62e555df Added quotes to start and end samples 2017-09-30 19:57:02 +02:00
Dag Wieers 3749ba6ee1 Small changes. 2017-09-30 19:57:02 +02:00
Prasad Katti b7fbc57227 Document return values for command module 2017-09-30 19:57:02 +02:00
Ganesh Nalawade 97858d91ac Add alias to command option in telnet (#30825)
*  Add commands alias to telnet option
2017-09-28 18:07:37 +05:30