نام (NAME)

puppet-device - مدیریت دستگاه‌های شبکه از راه دور از طریق OpenVox

خلاصه دستور (SYNOPSIS)

کاتالوگ‌ها را از سرور OpenVox دریافت کرده و آن‌ها را روی دستگاه‌های از راه دور اعمال می‌کند.

این زیردستور می‌تواند به‌صورت دستی، یا به‌طور دوره‌ای با استفاده از cron، یک وظیفه زمان‌بندی‌شده (scheduled task) یا ابزاری مشابه اجرا شود.

نحوه استفاده (USAGE)

توضیحات (DESCRIPTION)

دستگاه‌ها برای درخواست گواهی‌ها، جمع‌آوری factها، دریافت و اعمال کاتالوگ‌ها، و ذخیره گزارش‌ها به یک عامل (agent) پراکسی OpenVox نیاز دارند.

نکات استفاده (USAGE NOTES)

دستگاه‌هایی که توسط زیردستور puppet-device روی یک عامل OpenVox مدیریت می‌شوند، در device.conf پیکربندی می‌گردند که به‌طور پیش‌فرض در $confdir/device.conf قرار دارد و با تنظیم $deviceconfig قابل پیکربندی است.

فایل device.conf یک فایل مشابه INI است که برای هر دستگاه یک بخش مجزا دارد:

[DEVICE_CERTNAME] type TYPE url URL debug

نام بخش، certname دستگاه را مشخص می‌کند.

مقادیر ویژگی‌های type و url برای هر نوع دستگاه مختص همان نوع است.

ویژگی اختیاری debug اشکال‌زدایی در سطح لایه انتقال (transport) را مشخص می‌کند و محدود به روش‌های انتقال telnet و ssh است.

برای جزئیات بیشتر https://puppet.com/docs/puppet/latest/config_file_device.html را ببینید.

گزینه‌ها (OPTIONS)

توجه داشته باشید که هر تنظیمی که در فایل پیکربندی معتبر باشد، یک آرگومان بلند معتبر نیز به شمار می‌رود. برای نمونه، 'server' یک پارامتر پیکربندی معتبر است، بنابراین می‌توانید '--server servername' را به‌عنوان یک آرگومان مشخص کنید.

--help, -h: چاپ این پیام راهنما.
--verbose, -v: فعال‌سازی گزارش‌دهی پرجزئیات.
--debug, -d: فعال‌سازی اشکال‌زدایی کامل.
--logdest, -l: محل ارسال پیام‌های ثبت وقایع (لاگ). از میان 'syslog' (سرویس syslog در پوزیکس)، 'console'، یا مسیر یک فایل لاگ انتخاب کنید. اگر اشکال‌زدایی یا گزارش‌دهی پرجزئیات فعال باشد، مقدار پیش‌فرض 'console' است؛ در غیر این صورت، پیش‌فرض 'syslog' خواهد بود. مقصدهای متعدد را می‌توان با استفاده از یک فهرست جداشده با کاما تعیین کرد (مانند: /path/file1,console,/path/file2).

: مسیری که به '.json' ختم شود، خروجی ساختاریافته را در قالب JSON دریافت خواهد کرد. با توجه به ماهیت الحاقی لاگ‌گیری، علامت پایانی ']' به‌طور خودکار در فایل لاگ نوشته نخواهد شد؛ برای معتبر بودن ساختار JSON باید این علامت به‌صورت دستی در انتهای فایل اضافه شود.

--detailed-exitcodes: ارائه اطلاعات تراکنش از طریق کدهای خروج. در صورت فعال بودن این گزینه، کد خروج '1' به این معنی است که حداقل یک دستگاه خطای کامپایل داشته است، کد خروج '2' به این معنی است که حداقل یک دستگاه تغییرات منابع داشته است، و کد خروج '4' به این معنی است که حداقل یک دستگاه با شکست منابع مواجه شده است. کدهای خروج '3'، '5'، '6'، یا '7' نشان‌دهنده وقوع ترکیبی بیتی (bitwise) از کدهای خروج قبلی هستند.
--deviceconfig: مسیر فایل پیکربندی دستگاه برای puppet device. پیش‌فرض: $confdir/device.conf
--waitforcert, -w: این گزینه فقط برای مقصدهایی اهمیت دارد که هنوز گواهی ندارند و به‌طور پیش‌فرض با مقدار 120 (ثانیه) فعال است. این امر باعث می‌شود puppet device هر 2 دقیقه یک‌بار از سرور استعلام کرده (poll) و درخواست امضای گواهی کند. این قابلیت برای راه‌اندازی اولیه یک مقصد مفید است. می‌توانید با تعیین مقدار زمان 0، انتظار برای گواهی‌ها را غیرفعال کنید.
--libdir: جایگزینی libdir مربوط به هر دستگاه با یک دایرکتوری محلی. تعیین libdir همچنین pluginsync را غیرفعال می‌کند. این گزینه برای آزمایش مفید است.

: مسیری که به '.jsonl' ختم شود، خروجی ساختاریافته را در قالب خطوط JSON (JSON Lines) دریافت خواهد کرد.

--apply: اعمال یک مانیفست روی یک مقصد از راه دور. تعیین مقصد (target) الزامی است.
--facts: نمایش factهای یک مقصد از راه دور. تعیین مقصد (target) الزامی است.
--resource: نمایش وضعیت یک منبع به‌صورت کد Puppet، تقریباً معادل puppet resource. می‌تواند بر اساس عنوان فیلتر شود. مستلزم تعیین --target است.
--target: هدف‌گیری یک دستگاه/گواهی مشخص در device.conf. انجام این کار باعث می‌شود اجرای دستگاه فقط روی همان دستگاه/گواهی صورت گیرد.
--to_yaml: خروجی دادن منابع یافت‌شده در قالب yaml، مناسب برای استفاده با Hiera و create_resources.
--user: کاربری که دستور با هویت آن اجرا می‌شود.

مثال (EXAMPLE)

$ puppet device --target remotehost --verbose

نویسنده (AUTHOR)

Brice Figureau