.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ansible-doc" "1" "" "Ansible 2.21.3" "دستورات مدیریت سیستم"
.SH "نام (NAME)"
ansible-doc \- ابزار مستندسازی افزایه‌ها (پلاگین‌ها)
.SH "خلاصه دستور (SYNOPSIS)"
.INDENT 0.0
.TP
.B usage: ansible\-doc [\-h] [\-\-version] [\-v] [\-M MODULE_PATH]
[\-\-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 ...]
.UNINDENT
.SH "توضیحات (DESCRIPTION)"
.sp
اطلاعات مربوط به ماژول‌های نصب‌شده در کتابخانه‌های انسیبل (Ansible) را نمایش می‌دهد.
این ابزار فهرستی مختصر از افزایه‌ها و توضیحات کوتاه آن‌ها را نمایش داده،
رشته‌های DOCUMENTATION آن‌ها را چاپ می‌کند
و می‌تواند یک قطعه‌کد کوتاه (\(dqsnippet\(dq) بسازد که در پلی‌بوک قابل استفاده است.
.SH "گزینه‌های عمومی (COMMON OPTIONS)"
.INDENT 0.0
.INDENT 3.5
افزایه (Plugin)
.UNINDENT
.UNINDENT
.sp
\fB\-\-metadata\-dump\fP
.INDENT 0.0
.INDENT 3.5
\fBصرفاً برای استفاده داخلی\fP تخلیه متاداده JSON برای تمام مدخل‌ها؛ سایر گزینه‌ها را نادیده می‌گیرد.
.UNINDENT
.UNINDENT
.sp
\fB\-\-no\-fail\-on\-errors\fP
.INDENT 0.0
.INDENT 3.5
\fBصرفاً برای استفاده داخلی\fP تنها برای \-\-metadata\-dump استفاده می‌شود. هنگام بروز خطا متوقف نمی‌شود و در عوض پیام خطا را در خروجی JSON گزارش می‌کند.
.UNINDENT
.UNINDENT
.sp
\fB\-\-playbook\-dir\fP \(aqBASEDIR\(aq
.INDENT 0.0
.INDENT 3.5
از آنجا که این ابزار از پلی‌بوک‌ها استفاده نمی‌کند، این مسیر به عنوان دایرکتوری جایگزین پلی‌بوک در نظر گرفته می‌شود. این گزینه مسیر نسبی را برای بسیاری از ویژگی‌ها از جمله roles/ و group_vars/ و غیره تنظیم می‌کند.
.UNINDENT
.UNINDENT
.sp
\fB\-\-version\fP
.INDENT 0.0
.INDENT 3.5
نمایش شماره نسخه برنامه، مکان فایل پیکربندی، مسیر جستجوی ماژول‌های پیکربندی‌شده، مکان ماژول‌ها، مکان فایل اجرایی و خروج
.UNINDENT
.UNINDENT
.sp
\fB\-F\fP, \fB\-\-list_files\fP
.INDENT 0.0
.INDENT 3.5
نمایش نام افزایه‌ها و فایل‌های مبدأ آن‌ها بدون خلاصه‌ها (به معنای فعال بودن \-\-list نیز است). آرگومان ارائه‌شده برای پالایش استفاده می‌شود و می‌تواند یک فضای‌نام (namespace) یا نام کامل کلکسیون باشد.
.UNINDENT
.UNINDENT
.sp
\fB\-M\fP, \fB\-\-module\-path\fP
.INDENT 0.0
.INDENT 3.5
افزودن مسیر(های) جدا شده با دونقطه به ابتدای کتابخانه ماژول‌ها (پیش‌فرض: {{ ANSIBLE_HOME ~ \(dq/plugins/modules:/usr/share/ansible/plugins/modules\(dq }}). این آرگومان می‌تواند چندین بار مشخص شود.
.UNINDENT
.UNINDENT
.sp
\fB\-e\fP \(aqENTRY_POINT\(aq, \fB\-\-entry\-point\fP \(aqENTRY_POINT\(aq
.INDENT 0.0
.INDENT 3.5
انتخاب نقطه ورود برای نقش(ها) (role).
.UNINDENT
.UNINDENT
.sp
\fB\-h\fP, \fB\-\-help\fP
.INDENT 0.0
.INDENT 3.5
نمایش این پیام راهنما و خروج
.UNINDENT
.UNINDENT
.sp
\fB\-j\fP, \fB\-\-json\fP
.INDENT 0.0
.INDENT 3.5
تغییر قالب خروجی به فرمت JSON.
.UNINDENT
.UNINDENT
.sp
\fB\-l\fP, \fB\-\-list\fP
.INDENT 0.0
.INDENT 3.5
فهرست کردن افزایه‌های موجود. آرگومان ارائه‌شده برای پالایش استفاده خواهد شد و می‌تواند یک فضای‌نام یا نام کامل کلکسیون باشد.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP, \fB\-\-roles\-path\fP
.INDENT 0.0
.INDENT 3.5
مسیر دایرکتوری حاوی نقش‌های شما. این آرگومان می‌تواند چندین بار مشخص شود.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP, \fB\-\-snippet\fP
.INDENT 0.0
.INDENT 3.5
نمایش قطعه‌کد (snippet) پلی‌بوک برای این نوع از افزایه‌ها: inventory، lookup، module
.UNINDENT
.UNINDENT
.sp
\fB\-t\fP \(aqTYPE\(aq, \fB\-\-type\fP \(aqTYPE\(aq
.INDENT 0.0
.INDENT 3.5
انتخاب نوع افزایه (پیش‌فرض: \(dqmodule\(dq). انواع افزایه‌های در دسترس عبارتند از: (\(aqbecome\(aq, \(aqcache\(aq, \(aqcallback\(aq, \(aqcliconf\(aq, \(aqconnection\(aq, \(aqhttpapi\(aq, \(aqinventory\(aq, \(aqlookup\(aq, \(aqnetconf\(aq, \(aqshell\(aq, \(aqvars\(aq, \(aqmodule\(aq, \(aqstrategy\(aq, \(aqtest\(aq, \(aqfilter\(aq, \(aqrole\(aq, \(aqkeyword\(aq)
.UNINDENT
.UNINDENT
.sp
\fB\-v\fP, \fB\-\-verbose\fP
.INDENT 0.0
.INDENT 3.5
موجب چاپ پیام‌های اشکال‌زدایی بیشتر توسط انسیبل می‌شود. افزودن چندین \-v سطح جزئیات را افزایش می‌دهد؛ افزایه‌های توکار فعلاً تا \-vvvvvv را ارزیابی می‌کنند. یک سطح منطقی برای شروع \-vvv است، و اشکال‌زدایی ارتباطات ممکن است به \-vvvv نیاز داشته باشد. این آرگومان می‌تواند چندین بار مشخص شود.
.UNINDENT
.UNINDENT
.SH "متغیرهای محیطی (ENVIRONMENT)"
.sp
متغیرهای محیطی زیر را می‌توان تعیین کرد:
.sp
ANSIBLE_LIBRARY \-\- بازنویسی مسیر پیش‌فرض کتابخانه ماژول‌های انسیبل
.sp
ANSIBLE_CONFIG \-\- مشخص کردن مکان جایگزین برای فایل پیکربندی انسیبل
.sp
متغیرهای بسیار بیشتری برای اغلب گزینه‌ها در ansible.cfg موجود هستند.
.sp
برای فهرست کامل وب‌سایت \%<https://\:docs\:.ansible\:.com>\& را بررسی کنید یا از دستور \fIansible\-config\fP استفاده نمایید.
.SH "پرونده‌ها (FILES)"
.sp
/etc/ansible/ansible.cfg \-\- فایل پیکربندی، در صورت وجود استفاده می‌شود
.sp
~/.ansible.cfg \-\- فایل پیکربندی کاربر، در صورت وجود بر پیکربندی پیش‌فرض اولویت دارد
.sp
\&./ansible.cfg \-\- فایل پیکربندی محلی (در پوشه کاری جاری) که فرض می‌شود مختص پروژه است و در صورت وجود بر بقیه اولویت دارد.
.sp
همان‌طور که در بالا اشاره شد، متغیر محیطی ANSIBLE_CONFIG بر تمام موارد دیگر اولویت خواهد داشت.
.SH "نویسنده (AUTHOR)"
.sp
انسیبل در اصل توسط Michael DeHaan نوشته شده است.
.SH "حق نشر (COPYRIGHT)"
.sp
حق نشر © 2018 Red Hat, Inc | Ansible.
انسیبل تحت شرایط مجوز GPLv3 منتشر شده است.
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBansible\fP (1), \fBansible\-config\fP (1), \fBansible\-console\fP (1), \fBansible\-galaxy\fP (1), \fBansible\-inventory\fP (1), \fBansible\-playbook\fP (1), \fBansible\-pull\fP (1), \fBansible\-vault\fP (1)
.sp
مستندات جامع در وب‌سایت مستندات در دسترس است:
\%<https://\:docs\:.ansible\:.com>.
اطلاعات IRC و فهرست پستی در پرونده CONTRIBUTING.md قابل مشاهده است،
موجود در: \%<https://\:github\:.com/\:ansible/\:ansible>
.\" End of generated man page.