Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teramako/jagabata.psm
PowerShell module for AWX/AnsibleTower
https://github.com/teramako/jagabata.psm
awx-ansible powershell-module
Last synced: about 1 month ago
JSON representation
PowerShell module for AWX/AnsibleTower
- Host: GitHub
- URL: https://github.com/teramako/jagabata.psm
- Owner: teramako
- License: mpl-2.0
- Created: 2024-06-15T13:13:14.000Z (8 months ago)
- Default Branch: develop
- Last Pushed: 2024-10-24T05:10:16.000Z (4 months ago)
- Last Synced: 2024-10-24T22:59:15.032Z (4 months ago)
- Topics: awx-ansible, powershell-module
- Language: C#
- Homepage:
- Size: 4.74 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jagabata.psm 🥔🧈
PowerShell module to operate AWX/AnsibleTower using [Rest API].
- Required: PowerShell 7
- Supports Windows, GNU/Linux, macOS
- Much number of commands are available (nearly 200). See: Command list [by verb] or [by noun].
- Retrieve various information (`Get-*`, `Find-*`)
- Launch, wait or stop jobs such as JobTemplate, WorkflowJobTemplate, etc (`Start-*`, `Invoke-*`, `Wait-`, `Stop-*`)
- Creating new resources such as Users, JobTemplates, Credential, etc. (`New-*`)
- Update existing resources (`Update-*`)
- Associate or Unassociate a resource with another resource (`Register-*`, `Unregister-*`)
- Delete resources (`Remove-*`)
[by verb]: docs/en-US/CommandListByVerb.md
[by noun]: docs/en-US/CommandListByNoun.md
## 🎥 Demo
See: [All demo movies](docs/demo/)
## 🚀 Get Started
### 1. Install Jagabata.psm from [PowerShell Gallery].
```powershell
Install-Module -Name Jagabata.psm -Scope CurrentUser
```
### 2. Import module
```powershell
Import-Module Jagabata.psm
```
All commands of Jagabata.psm are added "Ansible" prefix by default, like `Get-Host` -> `Get-AnsibleHost`
> [!TIP]
> Please use the `-Prefix` parameter to change the prefix.
> For example:
> ```powershell
> Import-Module Jagabata.psm -Prefix Awx
> ```
> All commands of Jagabata.psm will be added "Awx" prefix instead of "Ansible", like `Get-Host` -> `Get-AwxHost`.
### 3. Get Poersonal Access Token
Login to AWX/AnsibleTower to obtain a Personal Access Token (PAT) and
create a configuration file with the [New-AnsibleApiConfig](./docs/en-US/cmdlets/New-AnsibleApiConfig.md) command.
See [Settings](./docs/en-US/settings.md) for more details.
### 4. Completed
Now you are ready. Now execute your favorite command!
## 🚧 Build
See [Build](./docs/en-US/build.md) document.
[Rest API]: https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/index.html "AWX API Reference — Ansible AWX community documentation"
[Powershell Gallery]: https://www.powershellgallery.com/packages/Jagabata.psm