פירוש תוכן קובץ העזרה ועדכון תוכן העזרה המקומי ב- PowerShell

הושלם

כאשר תמצא את הפקודה הדרושה לך עבור משימה, תוכל להשתמש בקובץ העזרה שלה כדי ללמוד כיצד להשתמש בה. דרך אחת ללמוד היא לסקור את הדוגמאות ולנסות להבין את השימוש שלהן. עם זאת, לא נדיר שדוגמאות מכסות את כל הווריאציות האפשריות של שימוש בפקודה זו. למידה לפרש את תחביר קובץ העזרה יכולה לעזור לך לזהות את כל היכולות של פקודה נתונה.

Get-EventLog עזרה

השתמש בעזרה עבור Get-EventLog כדוגמה. אם תזין את Get-Help Get-EventLog במסוף ותהקיש על מקש Enter, העזרה תחזיר את התחביר הבא:

Get-EventLog [-LogName] <String> [[-InstanceId] <Int64[]>] [-After <DateTime>] [-AsBaseObject] [-Before <DateTime>] [-ComputerName <String[]>] [-EntryType {Error | Information | FailureAudit | SuccessAudit | Warning}] [-Index <Int32[]>] [-Message <String>] [-Newest <Int32>] [-Source <String[]>] [-UserName <String[]>] [<CommonParameters>]

Get-EventLog [-AsString] [-ComputerName <String[]>] [-List] [<CommonParameters>]

שני בלוקי הטקסט מוגדרים פרמטרים, שכל אחת מהן מייצגת דרך שבה ניתן להפעיל את הפקודה. שים לב שכל ערכת פרמטרים כוללת פרמטרים רבים, ולשניהם יש מספר פרמטרים משותפים. לא ניתן לשלב ולהתאם פרמטרים בין ערכות. לדוגמה, אם תחליט להשתמש בפרמטר –List, לא תוכל להשתמש גם ב- –LogName, מאחר שפרמטרים אלה אינם מופיעים יחד באותה ערכת פרמטרים.

שם -LogName הפרמטר מוקף בסוגריים מרובעים, כלומר זהו פרמטר מיקום. לא ניתן להפעיל את הפקודה ללא שם יומן רישום. עם זאת, אין צורך להזין את שם הפרמטר –LogName הפרמטר. עליך להעביר את מחרוזת שם יומן הרישום בתור הפרמטר הראשון, מכיוון שזהו המיקום בקובץ העזרה שבו מופיע הפרמטר -LogName הבא. לכן, שתי הפקודות הבאות מספקות את אותן תוצאות:

Get-EventLog –LogName Application
Get-EventLog Application

השמטת שמות פרמטרים

היזהר בעת השמטת שמות פרמטרים, מכמה סיבות. לא ניתן להשמיט כל פרמטר. לדוגמה, הפרמטר -ComputerName אינו יכול להשמיט את שם הפרמטר. בנוסף, תוכל לאבד במהירות את המעקב אחר הפריטים. בעת מתן שמות פרמטרים, הפרמטרים יכולים להופיע בכל סדר, כפי שהפקודה הבאה מתארת:

Get-EventLog –ComputerName LON-DC1 –LogName Application –Newest 10

עם זאת, בעת השמטת שמות פרמטרים, עליך לוודא להזין פרמטרים בסדר הנכון. לדוגמה, הפקודה הבאה לא תפעל מאחר שערך שם יומן הרישום אינו מופיע במיקום הנכון:

Get-EventLog –ComputerName LON-DC1 Application

ציון ערכים מרובים

פרמטרים מסוימים מקבלים יותר מערך אחד. במקטע תחביר, סימון סוגר מרובע כפול בסוג ערך הפרמטר יציין פרמטרים אלה. לדוגמה:

-ComputerName <string[]>

התחביר לעיל מציין שהפרמטר -ComputerName - יכול לקבל ערך מחרוזת אחד או יותר. דרך אחת לציין ערכים מרובים היא באמצעות רשימה מופרדת באמצעות פסיקים. אין צורך להקיף את הערכים במרכאות, אלא אם הערכים עצמם מכילים פסיק או רווח לבן, כגון רווח או תו טאב. לדוגמה, השתמש בפקודה הבאה כדי לציין שמות מחשבים מרובים:

Get-EventLog –LogName Application –ComputerName LON-CL1,LON-DC1

הערה

באפשרותך למצוא מידע נוסף אודות כל פרמטר על-ידי סקירת העזרה המלאה של הפקודה. לדוגמה, הפעל את Get-Help Get-EventLog –מלא כדי לסקור את העזרה המלאה עבור Get-EventLogובחין במידע הנוסף המוצג. לדוגמה, באפשרותך לאשר שהפרמטר -LogName הוא הכרחי ומופיע במיקום הראשון.

מומלצת זו: אם אתה רק מתחיל בעבודה עם Windows PowerShell, נסה לספק שמות פרמטרים מלאים במקום להעביר ערכי פרמטרים לפי מיקום. שמות פרמטרים מלאים מקלים עליך לסקור ולפתור בעיות, והם מקלים עליך בחין בטעויות אם אתה מזין את הפקודה באופן שגוי.

עדכון עזרה

Windows PowerShell 3.0 וגירסאות חדשות יותר אינם נשלחים עם קבצי עזרה. במקום זאת, קבצי עזרה זמינים כשירות מקוון. הפקודות של Microsoft כוללות את קבצי העזרה שלהן המתארחים בשרתי אינטרנט בבעלות Microsoft. פקודות שאינן של Microsoft זמינות לעתים באינטרנט, כל עוד המחבר או הספק בונה את המודול כהלכה ומספק מיקום מקוון עבור קבצי העזרה. על-ידי שימוש במודל המקוון, מחברים שכותבים פקודות, כולל מחברים של Microsoft, יכולים לבצע תיקונים ושיפורים בקובצי העזרה שלהם לאורך זמן, ולאחר מכן לספק אותם ללא צורך ליצור עדכון מוצר שלם.

הפעל עדכון-עזרה כדי לסרוק את המחשב שלך כדי לאתר את כל המודולים המותקנים, לאחזר מיקומי עזרה מקוונים עבור כל אחד מהם ולנסות להוריד את קבצי העזרה המתאימים שלהם. עליך להפעיל פקודה זו כחבר בקבוצה Administrators, מאחר שבעזרה של פקודות הליבה של Windows PowerShell מאוחסנת בתיקיה %systemdir%. הודעות שגיאה יוצגו אם לא ניתן להוריד את העזרה. במקרים כאלה, Windows PowerShell עדיין ייצור תצוגת עזרה המהווה ברירת מחדל עבור הפקודות.

ברירת המחדל של Windows PowerShell להורדת קבצי עזרה בשפה שתצורתה נקבעה במערכת שלך. אם עזרה אינה זמינה בשפה זו, ברירת המחדל של Windows PowerShell היא השפה en-US (אנגלית ארה"ב). באפשרותך לעקוף אופן פעולה זה באמצעות פרמטר של Update-Help כדי לציין את UICulture שעבורו ברצונך לאחזר עזרה.

כברירת מחדל, עדכון-עזרה לחפש קבצי עזרה פעם אחת בכל 24 שעות, גם אם אתה מפעיל את הפקודה כמה פעמים ברצף. כדי לעקוף אופן פעולה זה, כלול את –Force parameter.

המסייע ל- עדכון-עזרה משתמש עזרה. הוא מוריד את תוכן העזרה ו שומר אותו במיקום שתציין. תכונה זו מאפשרת לך להעתיק תוכן זה למחשבים שאינם מחוברים לאינטרנט. עדכון-עזרה פרמטר לציון מיקום מקור חלופי. תכונה זו מאפשרת לעדכן עזרה במחשבים שאינם מחוברים לאינטרנט.

לפני Windows PowerShell 4.0, Update-Help ו- Save-Help download help only for the cmdlets installed on the local computer (where you run the command from). ב- Windows PowerShell 4.0 ואילך, באפשרותך להשתמש שמור-עזרה המודולים המותקנים במחשבים מרוחקים.