Ansible API のドキュメント
Ansible API を構築中です。属性、クラス、関数、メソッド、およびモジュールのスタブ参照の説明は、今後追加されます。ansible.module_utils.basic および AnsibleModule に含まれる「モジュールユーティリティー」、「参照および付録」に記載されています。
属性
- AnsibleModule.params
モジュールで受け入れられるパラメーターです。
- ansible.module_utils.basic.ANSIBLE_VERSION
- ansible.module_utils.basic.SELINUX_SPECIAL_FS
ansibleModule._selinux_special_fs が導入されたため、非推奨となりました。
- AnsibleModule.ansible_version
- AnsibleModule._debug
- AnsibleModule._diff
- AnsibleModule.no_log
- AnsibleModule._selinux_special_fs
(以前は ansible.module_utils.basic.SELINUX_SPECIAL_FS)
- AnsibleModule._syslog_facility
- self.playbook
- self.play
- self.task
- sys.path
クラス
- ``ansible.module_utils.basic.AnsibleModule``
AnsibleModule の基本的なユーティリティーです。
- class AnsibleModule
Ansible モジュールのメインクラスです。
関数
- ansible.module_utils.basic._load_params()
パラメーターを読み込みます。
メソッド
- AnsibleModule.log()
Ansible の出力をログに記録します。
- AnsibleModule.debug()
Ansible をデバッグします。
- Ansible.get_bin_path()
実行可能ファイルのパスを取得します。
- AnsibleModule.run_command()
Ansible モジュール内でコマンドを実行します。
- module.fail_json()
終了して、失敗を返します。
- module.exit_json()
終了して、出力を返します。