ansible-console(1) دستورات مدیریت سیستم ansible-console(1)

ansible-console - کنسول تعاملی (REPL) برای اجرای وظایف Ansible

[--become-method BECOME_METHOD] [--become-user BECOME_USER] [-K | --become-password-file BECOME_PASSWORD_FILE] [-i INVENTORY] [--list-hosts] [-l SUBSET] [--flush-cache] [--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT] [--ssh-common-args SSH_COMMON_ARGS] [--sftp-extra-args SFTP_EXTRA_ARGS] [--scp-extra-args SCP_EXTRA_ARGS] [--ssh-extra-args SSH_EXTRA_ARGS] [-k | --connection-password-file CONNECTION_PASSWORD_FILE] [-C] [-D] [--vault-id VAULT_IDS] [-J | --vault-password-file VAULT_PASSWORD_FILES] [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR] [-e EXTRA_VARS] [--task-timeout TASK_TIMEOUT] [--step] [pattern]

یک کنسول تعاملی (REPL) که امکان اجرای وظایف فی‌البداهه (ad-hoc) را در برابر یک اینونتوری انتخابی، از طریق یک پوسته مناسب با قابلیت تکمیل خودکار با کلید تب (tab completion) فراهم می‌کند (بر پایه ansible-shell متعلق به dominis).

این ابزار از چندین دستور پشتیبانی می‌کند و می‌توانید پیکربندی آن را در زمان اجرا تغییر دهید:

  • cd [pattern]: تغییر میزبان/گروه (می‌توانید از الگوهای میزبان استفاده کنید؛ مثلاً: app*.dc*:!app01*)
  • list: فهرست کردن میزبان‌های موجود در مسیر جاری
  • list groups: فهرست کردن گروه‌های موجود در مسیر جاری
  • become: تغییر وضعیت فلگ become
  • !: اجبار به استفاده از ماژول shell به جای ماژول ansible (!yum update -y)
  • verbosity [num]: تنظیم سطح جزئیات خروجی (verbosity)
  • forks [num]: تنظیم تعداد فرآیندهای موازی (forks)
  • become_user [user]: تنظیم become_user
  • remote_user [user]: تنظیم remote_user
  • become_method [method]: تنظیم روش ارتقای دسترسی (privilege escalation)
  • check [bool]: تغییر وضعیت حالت بررسی (check mode)
  • diff [bool]: تغییر وضعیت حالت مقایسه (diff mode)
  • timeout [integer]: تنظیم مهلت زمانی وظایف به ثانیه (0 برای غیرفعال کردن)
  • help [command/module]: نمایش مستندات برای دستور یا ماژول
  • exit: خروج از ansible-console

الگوی میزبان (host pattern)

--become-method 'BECOME_METHOD'

روش ارتقای دسترسی مورد استفاده (پیش‌فرض: sudo)، از ansible-doc -t become -l برای فهرست کردن گزینه‌های معتبر استفاده کنید.

--become-password-file 'BECOME_PASSWORD_FILE', --become-pass-file 'BECOME_PASSWORD_FILE'

فایل گذرواژه ارتقای دسترسی (become)

--become-user 'BECOME_USER'

اجرای عملیات با این کاربر (پیش‌فرض: root)

--connection-password-file 'CONNECTION_PASSWORD_FILE', --conn-pass-file 'CONNECTION_PASSWORD_FILE'

فایل گذرواژه اتصال

--flush-cache

پاکسازی حافظه نهان فکت‌ها (fact cache) برای تمام میزبان‌های موجود در اینونتوری

--list-hosts

فهرستی از میزبان‌های منطبق را چاپ می‌کند؛ هیچ عملیات دیگری را اجرا نمی‌کند

--playbook-dir 'BASEDIR'

از آن‌جا که این ابزار از پلی‌بوک‌ها استفاده نمی‌کند، از این دایرکتوری به عنوان جایگزین پوشه پلی‌بوک استفاده کنید. این گزینه مسیر نسبی را برای بسیاری از ویژگی‌ها از جمله roles/، group_vars/ و غیره تنظیم می‌کند.

--private-key 'PRIVATE_KEY_FILE', --key-file 'PRIVATE_KEY_FILE'

استفاده از این فایل برای احراز هویت اتصال

--scp-extra-args 'SCP_EXTRA_ARGS'

تعیین آرگومان‌های اضافی برای ارسال اختصاصی به scp (مانند -l)

--sftp-extra-args 'SFTP_EXTRA_ARGS'

تعیین آرگومان‌های اضافی برای ارسال اختصاصی به sftp (مانند -f، -l)

--ssh-common-args 'SSH_COMMON_ARGS'

تعیین آرگومان‌های مشترک برای ارسال به sftp/scp/ssh (مانند ProxyCommand)

--ssh-extra-args 'SSH_EXTRA_ARGS'

تعیین آرگومان‌های اضافی برای ارسال اختصاصی به ssh (مانند -R)

--step

گام‌به‌گام: تایید هر وظیفه پیش از اجرا

--task-timeout 'TASK_TIMEOUT'

تنظیم محدودیت مهلت زمانی وظیفه (task) به ثانیه؛ باید یک عدد صحیح مثبت باشد.

--vault-id

شناسه والت (vault identity) برای استفاده. این آرگومان می‌تواند چندین بار مشخص شود.

--vault-password-file, --vault-pass-file

فایل گذرواژه والت

--version

نمایش شماره نسخه برنامه، مکان فایل پیکربندی، مسیر جستجوی ماژول‌های پیکربندی‌شده، مکان ماژول، مکان فایل اجرایی و خروج

-C, --check

هیچ تغییری اعمال نمی‌کند؛ در عوض سعی می‌کند برخی از تغییراتی که ممکن است رخ دهد را پیش‌بینی کند

-D, --diff

هنگام تغییر فایل‌ها و قالب‌های (کوچک)، تفاوت‌ها را در آن فایل‌ها نشان می‌دهد؛ همراه با --check بسیار عالی عمل می‌کند

-J, --ask-vault-password, --ask-vault-pass

درخواست گذرواژه والت

-K, --ask-become-pass

درخواست گذرواژه ارتقای دسترسی (privilege escalation)

-M, --module-path

افزودن مسیر(های) جداشده با دونقطه به ابتدای کتابخانه ماژول‌ها (پیش‌فرض: {{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}). این آرگومان را می‌توان چندین بار مشخص کرد.

-T 'TIMEOUT', --timeout 'TIMEOUT'

بازنویسی مهلت زمانی اتصال به ثانیه (پیش‌فرض بستگی به نوع اتصال دارد)

-b, --become

اجرای عملیات با become (به معنای درخواست گذرواژه نیست)

-c 'CONNECTION', --connection 'CONNECTION'

نوع اتصال مورد استفاده (پیش‌فرض: ssh)

-e, --extra-vars

تنظیم متغیرهای اضافی به صورت کلید=مقدار یا YAML/JSON؛ در صورت فایل بودن نام با @ شروع شود. این آرگومان می‌تواند چندین بار مشخص شود.

-f 'FORKS', --forks 'FORKS'

تعیین تعداد فرآیندهای موازی برای استفاده (پیش‌فرض: 5)

-h, --help

نمایش این پیام راهنما و خروج

-i, --inventory, --inventory-file

مشخص کردن مسیر اینونتوری میزبان‌ها یا فهرست میزبان‌های جداشده با کاما. این آرگومان را می‌توان چندین بار مشخص کرد.

-k, --ask-pass

درخواست گذرواژه اتصال

-l 'SUBSET', --limit 'SUBSET'

محدود کردن بیشتر میزبان‌های انتخاب‌شده بر اساس یک الگوی اضافی

-u 'REMOTE_USER', --user 'REMOTE_USER'

اتصال با این کاربر (پیش‌فرض: None)

-v, --verbose

باعث می‌شود انسیبل پیام‌های اشکال‌زدایی بیشتری چاپ کند. افزودن چند -v سطح جزئیات را افزایش می‌دهد؛ پلاگین‌های داخلی فعلی تا -vvvvvv را ارزیابی می‌کنند. یک سطح معقول برای شروع -vvv است؛ اشکال‌زدایی اتصال ممکن است به -vvvv نیاز داشته باشد. این آرگومان را می‌توان چندین بار مشخص کرد.

host-pattern

نام یک گروه در اینونتوری، یک تطابق سراسری (glob) شبیه به پوسته برای انتخاب میزبان‌ها در اینونتوری، یا هر ترکیبی از این دو که با کاما از هم جدا شده باشند.

انسیبل میزبان‌هایی را که به طور بالقوه می‌تواند روی آن‌ها کار کند در یک اینونتوری نگهداری می‌نماید. این می‌تواند یک فایل YAML، فایل شبه-ini، یک اسکریپت، دایرکتوری، فهرست و غیره باشد. برای گزینه‌های اضافی، مستندات موجود در https://docs.ansible.com را ببینید.

متغیرهای محیطی زیر را می‌توان تعیین کرد:

ANSIBLE_INVENTORY -- بازنویسی منابع پیش‌فرض اینونتوری انسیبل

ANSIBLE_LIBRARY -- بازنویسی مسیر پیش‌فرض کتابخانه ماژول‌های انسیبل

ANSIBLE_CONFIG -- تعیین مسیر جایگزین برای فایل پیکربندی انسیبل

متغیرهای بسیار بیشتری برای اغلب گزینه‌ها در ansible.cfg موجود هستند.

برای فهرست کامل به https://docs.ansible.com مراجعه کنید یا از دستور ansible-config بهره بگیرید.

/etc/ansible/hosts -- فایل پیش‌فرض اینونتوری

/etc/ansible/ansible.cfg -- فایل پیکربندی، در صورت وجود استفاده می‌شود

~/.ansible.cfg -- فایل پیکربندی کاربر، در صورت وجود بر پیکربندی پیش‌فرض اولویت دارد

./ansible.cfg -- فایل پیکربندی محلی (در دایرکتوری کاری جاری) که فرض می‌شود «مختص پروژه» است و در صورت وجود بر بقیه اولویت دارد.

همان‌طور که در بالا اشاره شد، متغیر محیطی ANSIBLE_CONFIG بر تمام موارد دیگر اولویت خواهد داشت.

Ansible در ابتدا توسط Michael DeHaan نوشته شد.

حق نشر © 2018 Red Hat, Inc | Ansible. Ansible تحت شرایط مجوز GPLv3 منتشر شده است.

ansible (1), ansible-config (1), ansible-doc (1), ansible-galaxy (1), ansible-inventory (1), ansible-playbook (1), ansible-pull (1), ansible-vault (1)

مستندات جامع در وب‌سایت مستندات در دسترس است: https://docs.ansible.com. اطلاعات مربوط به IRC و فهرست پستی را می‌توان در فایل CONTRIBUTING.md یافت، موجود در: https://github.com/ansible/ansible

Ansible 2.21.3