.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "PUPPET\-MODULE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
.SH "نام (NAME)"
\fBpuppet\-module\fR \- ساخت، نصب و جستجوی ماژول‌ها در Puppet Forge
.SH "خلاصه دستور (SYNOPSIS)"
puppet module \fIاقدام\fR [\-\-environment production ] [\-\-modulepath ]
.SH "توضیحات (DESCRIPTION)"
این زیردستور می‌تواند ماژول‌ها را از Puppet Forge (مخزنی از کدهای پاپت ارائه‌شده توسط کاربران) پیدا، نصب و مدیریت کند\&. همچنین می‌تواند ماژول‌های خالی تولید کند و ماژول‌های توسعه‌یافته محلی را برای انتشار در Forge آماده سازد\&.
.SH "گزینه‌ها (OPTIONS)"
توجه داشته باشید که هر تنظیمی که در فایل پیکربندی معتبر باشد، به عنوان یک آرگومان بلند نیز معتبر است، هرچند ممکن است به اقدام فعلی مربوط باشد یا نباشد\&. برای مثال، \fBserver\fR و \fBrun_mode\fR تنظیمات معتبری هستند، بنابراین می‌توانید \fB\-\-server <servername>\fR یا \fB\-\-run_mode <runmode>\fR را به عنوان یک آرگومان مشخص کنید\&.
.P
برای فهرست کامل پارامترهای قابل قبول، مستندات فایل پیکربندی را در نشانی \fIhttps://puppet\.com/docs/puppet/latest/configuration\.html\fR ببینید\&. فهرستی حاوی توضیحات از تمام گزینه‌های پیکربندی را نیز می‌توان با اجرای puppet به همراه \fB\-\-genconfig\fR تولید کرد\&.
.TP
\-\-render\-as FORMAT
قالبی که خروجی در آن ارائه می‌شود\&. متداول‌ترین قالب‌ها عبارتند از \fBjson\fR، \fBs\fR (رشته)، \fByaml\fR و \fBconsole\fR، اما گزینه‌های دیگری مانند \fBdot\fR نیز گاهی در دسترس هستند\&.
.TP
\-\-verbose
ثبت وقایع با جزئیات کامل\&.
.TP
\-\-debug
ثبت اطلاعات اشکال‌زدایی\&.
.TP
\-\-environment production
محیطی که پاپت در آن اجرا می‌شود\&. برای کلاینت‌ها، نظیر \fBpuppet agent\fR، این گزینه خود محیط را تعیین می‌کند که پاپت از آن برای یافتن ماژول‌ها و بسیاری موارد دیگر استفاده می‌کند\&. برای سرورها، نظیر \fBpuppet server\fR، محیط پیش‌فرضی را برای گره‌هایی که پاپت شناختی از آن‌ها ندارد فراهم می‌سازد\&.
.IP
هنگام تعریف محیط در بخش \fB[agent]\fR، این به محیطی اشاره دارد که عامل از سرور اصلی درخواست می‌کند\&. نیازی نیست که محیط در سیستم‌فایل محلی وجود داشته باشد زیرا عامل آن را از سرور اصلی دریافت می‌کند\&. این تعریف هنگام اجرای \fBpuppet agent\fR استفاده می‌شود\&.
.IP
هنگام تعریف در بخش \fB[user]\fR، محیط به مسیری اشاره دارد که پاپت برای جستجوی کدها و ماژول‌های مربوط به اجرای خود به کار می‌برد\&. این تعریف مستلزم وجود محلی محیط در سیستم‌فایلی است که puppet در آن اجرا می‌شود\&. زیردستورهای پاپت، از جمله \fBpuppet module\fR و \fBpuppet apply\fR، از این تعریف استفاده می‌کنند\&.
.IP
با توجه به اینکه بافتار و اثرات بسته به بخش پیکربندی (\fIhttps://puppet\.com/docs/puppet/latest/config_file_main\.html#config\-sections\fR) که تنظیم \fBenvironment\fR در آن تعریف شده متفاوت است، آن را به طور سراسری تنظیم نکنید\&.
.TP
\-\-modulepath
مسیر جستجوی ماژول‌ها، به صورت فهرستی از دایرکتوری‌ها که با نویسه جداکننده مسیر سیستم از هم جدا شده‌اند\&. (جداکننده مسیر POSIX علامت ':' و جداکننده مسیر ویندوز ';' است\&.)
.IP
تنظیم یک مقدار سراسری برای \fBmodulepath\fR در puppet\.conf مجاز نیست (اما می‌توان آن را از خط فرمان بازنویسی کرد)\&. لطفاً در عوض از محیط‌های دایرکتوری استفاده کنید\&. اگر نیاز به استفاده از مقداری غیر از مسیر پیش‌فرض ماژول‌ها یعنی \fB<ACTIVE ENVIRONMENT'S MODULES DIR>:$basemodulepath\fR دارید، می‌توانید \fBmodulepath\fR را در environment\.conf تنظیم کنید\&. برای اطلاعات بیشتر پیوند \fIhttps://puppet\.com/docs/puppet/latest/environments_about\.html\fR را ببینید\&.
.SH "اقدامات (ACTIONS)"
.TP
\fBchanges\fR \- نمایش فایل‌های تغییریافته یک ماژول نصب‌شده\&.
\fBSYNOPSIS\fR
.IP
puppet module changes \fIpath\fR
.IP
\fBDESCRIPTION\fR
.IP
نمایش فایل‌هایی از یک ماژول که پس از نصب تغییر یافته‌اند\&. این اقدام فایل‌های روی دیسک را با چکسام‌های MD5 موجود در checksums\.json یا در صورت عدم وجود آن در metadata\.json مقایسه می‌کند\&.
.IP
\fBRETURNS\fR
.IP
آرایه‌ای از رشته‌ها که مسیر فایل‌های تغییریافته را نشان می‌دهند\&.
.TP
\fBinstall\fR \- نصب یک ماژول از Puppet Forge یا از یک آرشیو انتشار\&.
\fBSYNOPSIS\fR
.IP
puppet module install [\-\-force | \-f] [\-\-target\-dir DIR | \-i DIR] [\-\-ignore\-dependencies] [\-\-version VER | \-v VER] \fIname\fR
.IP
\fBDESCRIPTION\fR
.IP
یک ماژول را از Puppet Forge یا از یک فایل آرشیو انتشار نصب می‌کند\&. نکته: نصب ماژول از چکسام‌های MD5 استفاده می‌کند که در سیستم‌های با FIPS فعال ممنوع است\&.
.IP
ماژول مشخص‌شده در دایرکتوری تعیین‌شده با گزینه \fB\-\-target\-dir\fR نصب خواهد شد که به طور پیش‌فرض اولین دایرکتوری در modulepath است\&.
.IP
\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- اجبار به بازنویسی ماژول موجود در صورت وجود\&. این گزینه مستلزم \-\-ignore\-dependencies است\&.
.IP
\fI\-\-ignore\-dependencies\fR \- عدم تلاش برای نصب وابستگی‌ها\&. توسط \-\-force اعمال می‌شود\&.
.IP
\fI\-\-target\-dir DIR\fR | \fI\-i DIR\fR \- دایرکتوری‌ای که ماژول‌ها در آن نصب می‌شوند؛ پیش‌فرض اولین دایرکتوری در modulepath است\&.
.IP
مشخص کردن این گزینه دایرکتوری نصب را تغییر داده و از modulepath موجود هنگام بررسی وابستگی‌ها استفاده می‌کند\&. اگر مایلید مجموعه متفاوتی از دایرکتوری‌ها را برای وابستگی‌ها بررسی کنید، باید از گزینه‌های \fB\-\-environment\fR یا \fB\-\-modulepath\fR نیز استفاده کنید\&.
.IP
\fI\-\-version VER\fR | \fI\-v VER\fR \- نسخه ماژول برای نصب؛ می‌تواند یک نسخه دقیق یا رشته نیازمندی مانند '>= 1\.0\.3' باشد\&. پیش‌فرض آخرین نسخه است\&.
.IP
\fBRETURNS\fR
.IP
شیء Pathname که مسیر ماژول نصب‌شده را نشان می‌دهد\&.
.TP
\fBlist\fR \- فهرست کردن ماژول‌های نصب‌شده
\fBSYNOPSIS\fR
.IP
puppet module list [\-\-tree]
.IP
\fBDESCRIPTION\fR
.IP
ماژول‌های نصب‌شده پاپت را فهرست می‌کند\&. به‌طور پیش‌فرض، این اقدام modulepath را از بلوک \fB[main]\fR فایل puppet\.conf پویش می‌کند؛ از گزینه \-\-modulepath برای تغییر دایرکتوری‌های مورد پویش استفاده کنید\&.
.IP
خروجی این اقدام شامل اطلاعات متادیتای ماژول، از جمله شماره نسخه‌ها و وابستگی‌های برآورده‌نشده ماژول است\&.
.IP
\fBOPTIONS\fR \fI\-\-tree\fR \- نمایش وابستگی‌ها به صورت نمای درختی
.IP
\fBRETURNS\fR
.IP
جدول درهم‌سازی (Hash) از مسیرها به اشیاء ماژول
.TP
\fBuninstall\fR \- حذف نصب یک ماژول پاپت\&.
\fBSYNOPSIS\fR
.IP
puppet module uninstall [\-\-force | \-f] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR
.IP
\fBDESCRIPTION\fR
.IP
یک ماژول پاپت را از modulepath (یا یک دایرکتوری هدف خاص) حذف می‌کند\&. نکته: حذف نصب ماژول از چکسام‌های MD5 استفاده می‌کند که در سیستم‌های با FIPS فعال ممنوع است\&.
.IP
\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- اجبار به حذف نصب ماژول نصب‌شده حتی در صورت وجود تغییرات محلی یا احتمال شکستن وابستگی‌ها\&.
.IP
\fI\-\-ignore\-changes\fR | \fI\-c\fR \- حذف نصب یک ماژول نصب‌شده حتی اگر تغییرات محلی در آن ایجاد شده باشد\&. (توسط \-\-force اعمال می‌شود\&.)
.IP
\fI\-\-version=\fR \- نسخه ماژول برای حذف نصب\&. هنگام استفاده از این گزینه، ماژولی مطابق با نسخه مشخص‌شده باید نصب شده باشد وگرنه خطا رخ می‌دهد\&.
.IP
\fBRETURNS\fR
.IP
جدول درهم‌سازی از اشیاء ماژول که ماژول‌های حذف‌شده و خطاهای مرتبط را نشان می‌دهد\&.
.TP
\fBupgrade\fR \- ارتقای یک ماژول پاپت\&.
\fBSYNOPSIS\fR
.IP
puppet module upgrade [\-\-force | \-f] [\-\-ignore\-dependencies] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR
.IP
\fBDESCRIPTION\fR
.IP
یک ماژول پاپت را ارتقا می‌دهد\&. نکته: ارتقای ماژول از چکسام‌های MD5 استفاده می‌کند که در سیستم‌های با FIPS فعال ممنوع است\&.
.IP
\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- اجبار به ارتقای یک ماژول نصب‌شده حتی در صورت وجود تغییرات محلی یا احتمال شکستن وابستگی‌ها\&. مستلزم \-\-ignore\-dependencies است\&.
.IP
\fI\-\-ignore\-changes\fR | \fI\-c\fR \- ارتقای یک ماژول نصب‌شده حتی اگر تغییرات محلی در آن وجود داشته باشد\&. (توسط \-\-force اعمال می‌شود\&.)
.IP
\fI\-\-ignore\-dependencies\fR \- تلاش نکردن برای نصب وابستگی‌ها\&. توسط \-\-force اعمال می‌شود\&.
.IP
\fI\-\-version=\fR \- نسخه ماژول برای ارتقا به آن\&.
.IP
\fBRETURNS\fR
.IP
جدول درهم‌سازی (Hash)
.SH "مثال‌ها (EXAMPLES)"
\fBchanges\fR
.P
نمایش فایل‌های تغییریافته یک ماژول نصب‌شده:
.P
$ puppet module changes /etc/puppetlabs/code/modules/vcsrepo/ warning: 1 files modified lib/puppet/provider/vcsrepo\.rb
.P
\fBinstall\fR
.P
نصب یک ماژول:
.P
$ puppet module install puppetlabs\-vcsrepo Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب یک ماژول در محیطی مشخص:
.P
$ puppet module install puppetlabs\-vcsrepo \-\-environment development Preparing to install into /etc/puppetlabs/code/environments/development/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /etc/puppetlabs/code/environments/development/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب نسخه‌ای خاص از ماژول:
.P
$ puppet module install puppetlabs\-vcsrepo \-v 0\.0\.4 Preparing to install into /etc/puppetlabs/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب یک ماژول در دایرکتوری مشخص:
.P
$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/opt/puppetlabs/puppet/modules Preparing to install into /opt/puppetlabs/puppet/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /opt/puppetlabs/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب ماژول در دایرکتوری مشخص و بررسی وابستگی‌ها در سایر دایرکتوری‌ها:
.P
$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/opt/puppetlabs/puppet/modules \-\-modulepath /etc/puppetlabs/code/modules Preparing to install into /opt/puppetlabs/puppet/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /opt/puppetlabs/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب یک ماژول از یک آرشیو انتشار:
.P
$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
نصب ماژول از یک آرشیو انتشار و نادیده گرفتن وابستگی‌ها:
.P
$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz \-\-ignore\-dependencies Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\| Downloading from https://forgeapi\.puppet\.com \|\.\|\.\| Installing \-\Ref do not interrupt \|\.\|\.\| /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
.P
\fBlist\fR
.P
فهرست کردن ماژول‌های نصب‌شده:
.P
$ puppet module list /etc/puppetlabs/code/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /opt/puppetlabs/puppet/modules (no modules installed)
.P
فهرست کردن ماژول‌های نصب‌شده در نمای درختی:
.P
$ puppet module list \-\-tree /etc/puppetlabs/code/modules └─┬ puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-stdlib (v2\.2\.1) ├─┬ puppetlabs\-mysql (v0\.0\.1) │ └── bodepd\-create_resources (v0\.0\.1) └── puppetlabs\-sqlite (v0\.0\.1) /opt/puppetlabs/puppet/modules (no modules installed)
.P
فهرست کردن ماژول‌های نصب‌شده از یک محیط مشخص:
.P
$ puppet module list \-\-environment production /etc/puppetlabs/code/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /opt/puppetlabs/puppet/modules (no modules installed)
.P
فهرست کردن ماژول‌های نصب‌شده از یک modulepath مشخص:
.P
$ puppet module list \-\-modulepath /opt/puppetlabs/puppet/modules /opt/puppetlabs/puppet/modules (no modules installed)
.P
\fBuninstall\fR
.P
حذف نصب یک ماژول:
.P
$ puppet module uninstall puppetlabs\-ssh Removed /etc/puppetlabs/code/modules/ssh (v1\.0\.0)
.P
حذف نصب یک ماژول از یک دایرکتوری خاص:
.P
$ puppet module uninstall puppetlabs\-ssh \-\-modulepath /opt/puppetlabs/puppet/modules Removed /opt/puppetlabs/puppet/modules/ssh (v1\.0\.0)
.P
حذف نصب یک ماژول از یک محیط خاص:
.P
$ puppet module uninstall puppetlabs\-ssh \-\-environment development Removed /etc/puppetlabs/code/environments/development/modules/ssh (v1\.0\.0)
.P
حذف نصب یک نسخه خاص از ماژول:
.P
$ puppet module uninstall puppetlabs\-ssh \-\-version 2\.0\.0 Removed /etc/puppetlabs/code/modules/ssh (v2\.0\.0)
.P
\fBupgrade\fR
.P
ارتقای یک ماژول نصب‌شده به آخرین نسخه:
.P
$ puppet module upgrade puppetlabs\-apache /etc/puppetlabs/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0)
.P
ارتقای یک ماژول نصب‌شده به یک نسخه مشخص:
.P
$ puppet module upgrade puppetlabs\-apache \-\-version 2\.1\.0 /etc/puppetlabs/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.1\.0)
.P
ارتقای یک ماژول نصب‌شده برای یک محیط خاص:
.P
$ puppet module upgrade puppetlabs\-apache \-\-environment test /etc/puppetlabs/code/environments/test/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0)
.SH "حق نشر و مجوز (COPYRIGHT AND LICENSE)"
حق نشر ۲۰۱۲ توسط Puppet Inc\., Vox Pupuli تحت مجوز Apache 2؛ فایل COPYING را ببینید\&.