darthsoup / rundeck-php
rundeck php api
0.2
2018-01-11 02:26 UTC
Requires
- php: >=7.0.0
Requires (Dev)
- guzzlehttp/guzzle: ~6.0
- mockery/mockery: ~0.9
- phpunit/phpunit: ~6.0
Suggests
- guzzlehttp/guzzle: useable with guzzle 5 or 6
This package is auto-updated.
Last update: 2024-09-02 04:42:53 UTC
README
PHP API Wrapper for Rundeck
此包正在开发中,并非所有API功能都包含在内。
当前测试的Rundeck API版本为 20
,其他版本可能也适用,但未经过测试。
安装
您可以通过composer安装此包
composer require darthsoup/rundeck-php
使用方法
初始化API包装器
要初始化API包装器,注册一个HTTP适配器并创建Rundeck基类。
require_once '../vendor/autoload.php'; $adapter = new DarthSoup\Rundeck\Adapter\GuzzleHttpAdapter('<yourRundeckApiToken>'); $rundeck = new DarthSoup\Rundeck\Rundeck($adapter, 'https://<yourRundeckUrl>/api/20');
现在您可以开始了。
启动作业
通过runJob
方法启动作业,第一个参数为作业UUID。您还可以添加argString
来包含一些选项。
$job = $rundeck->job()->runJob('<YourJobUuid></YourJobUuid>', ['argString' => '-ArgTest1 yourstring']) var_dump($job);
作业执行信息
执行输出可以通过此命令返回。
$execution = $rundeck->execution()->output(<ExecutionId>) var_dump($execution);
Rundeck系统信息
获取当前Rundeck系统信息
$systeminfo = $rundeck->system()->info() var_dump(systeminfo);
支持
许可证
此包在MIT许可证下发布。有关详细信息,请参阅附带LICENSE文件。