Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLoses #20 #21

Merged
merged 3 commits into from
Jul 11, 2019
Merged

CLoses #20 #21

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbad5c8
Working towards #20
fireflycons Jul 9, 2019
80054cd
Update documentation
fireflycons Jul 11, 2019
523d4b0
Closes #20
fireflycons Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update documentation
  • Loading branch information
@fireflycons
fireflycons committed Jul 11, 2019
commit 80054cd422b92ccb816c7d67dc83c231b197d2f1
9 changes: 9 additions & 0 deletions aws-toolbox/Public/SSM/Invoke-ATSSMPowerShellScript.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ function Invoke-ATSSMPowerShellScript
.EXAMPLE
Invoke-ATSSMPowerShellScript -InstanceIds i-00000000 -AsText { dir c:\ }
Returns directory listing from remote instance to the console.

.NOTES
IAM permissions required to run this command

- ssm:GetConnectionStatus
- ssm:ListCommandInvocations
- ssm:ListCommands
- ssm:SendCommand
- ec2:DescribeInstances
#>
[CmdletBinding(DefaultParameterSetName = 'AsText')]
param
Expand Down
11 changes: 10 additions & 1 deletion aws-toolbox/Public/SSM/Invoke-ATSSMShellScript.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,17 @@ function Invoke-ATSSMShellScript
Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID

.EXAMPLE
Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText { ls -la / }
Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText "ls -la /"
Returns directory listing from remote instance to the console.

.NOTES
IAM permissions required to run this command

- ssm:GetConnectionStatus
- ssm:ListCommandInvocations
- ssm:ListCommands
- ssm:SendCommand
- ec2:DescribeInstances
#>
[CmdletBinding(DefaultParameterSetName = 'AsText')]
param
Expand Down
9 changes: 7 additions & 2 deletions docs/en-US/Invoke-ATSSMPowerShellScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,12 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
### - ResultObject If -AsJson and the result was successfully parsed, then an object else NULL
### - ResultText Standard Output returned by the script (Write-Host etc.)
## NOTES
aws-toolbox uses a working bucket for passing results through S3 which will be created if not found.
Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID
IAM permissions required to run this command

- ssm:GetConnectionStatus
- ssm:ListCommandInvocations
- ssm:ListCommands
- ssm:SendCommand
- ec2:DescribeInstances

## RELATED LINKS
11 changes: 8 additions & 3 deletions docs/en-US/Invoke-ATSSMShellScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Runs the command on the listed instances.

### EXAMPLE 2
```
Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText { ls -la / }
Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText "ls -la /"
```

Returns directory listing from remote instance to the console.
Expand Down Expand Up @@ -172,7 +172,12 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
### - ResultObject If -AsJson and the result was successfully parsed, then an object else NULL
### - ResultText Standard Output returned by the script (Write-Host etc.)
## NOTES
aws-toolbox uses a working bucket for passing results through S3 which will be created if not found.
Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID
IAM permissions required to run this command

- ssm:GetConnectionStatus
- ssm:ListCommandInvocations
- ssm:ListCommands
- ssm:SendCommand
- ec2:DescribeInstances

## RELATED LINKS