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

ansible-doc - ابزار مستندسازی افزایه‌ها (پلاگین‌ها)

[--playbook-dir BASEDIR] [-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,test,filter,role,keyword}] [-j] [-r ROLES_PATH] [-e ENTRY_POINT | -s | -F | -l | --metadata-dump] [--no-fail-on-errors] [plugin ...]

اطلاعات مربوط به ماژول‌های نصب‌شده در کتابخانه‌های انسیبل (Ansible) را نمایش می‌دهد. این ابزار فهرستی مختصر از افزایه‌ها و توضیحات کوتاه آن‌ها را نمایش داده، رشته‌های DOCUMENTATION آن‌ها را چاپ می‌کند و می‌تواند یک قطعه‌کد کوتاه ("snippet") بسازد که در پلی‌بوک قابل استفاده است.

افزایه (Plugin)

--metadata-dump

صرفاً برای استفاده داخلی تخلیه متاداده JSON برای تمام مدخل‌ها؛ سایر گزینه‌ها را نادیده می‌گیرد.

--no-fail-on-errors

صرفاً برای استفاده داخلی تنها برای --metadata-dump استفاده می‌شود. هنگام بروز خطا متوقف نمی‌شود و در عوض پیام خطا را در خروجی JSON گزارش می‌کند.

--playbook-dir 'BASEDIR'

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

--version

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

-F, --list_files

نمایش نام افزایه‌ها و فایل‌های مبدأ آن‌ها بدون خلاصه‌ها (به معنای فعال بودن --list نیز است). آرگومان ارائه‌شده برای پالایش استفاده می‌شود و می‌تواند یک فضای‌نام (namespace) یا نام کامل کلکسیون باشد.

-M, --module-path

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

-e 'ENTRY_POINT', --entry-point 'ENTRY_POINT'

انتخاب نقطه ورود برای نقش(ها) (role).

-h, --help

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

-j, --json

تغییر قالب خروجی به فرمت JSON.

-l, --list

فهرست کردن افزایه‌های موجود. آرگومان ارائه‌شده برای پالایش استفاده خواهد شد و می‌تواند یک فضای‌نام یا نام کامل کلکسیون باشد.

-r, --roles-path

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

-s, --snippet

نمایش قطعه‌کد (snippet) پلی‌بوک برای این نوع از افزایه‌ها: inventory، lookup، module

-t 'TYPE', --type 'TYPE'

انتخاب نوع افزایه (پیش‌فرض: "module"). انواع افزایه‌های در دسترس عبارتند از: ('become', 'cache', 'callback', 'cliconf', 'connection', 'httpapi', 'inventory', 'lookup', 'netconf', 'shell', 'vars', 'module', 'strategy', 'test', 'filter', 'role', 'keyword')

-v, --verbose

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

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

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

ANSIBLE_CONFIG -- مشخص کردن مکان جایگزین برای فایل پیکربندی انسیبل

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

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

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

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

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

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

انسیبل در اصل توسط Michael DeHaan نوشته شده است.

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

ansible (1), ansible-config (1), ansible-console (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