Swagger 指令範例

提交要執行的指令。

Swagger POST /command 範例

請執行下列步驟來執行 API:

展開指令區段。
按一下 POST /command。
按一下試用。
從下拉功能表中選取媒體類型。這會控制 curl 指令中的標頭接受類型。可能的值為 application/json 和 application/xml。
以下列格式指定要求內文，其中 commandName 是在 https://server-name/ws/powerscui/command的 commandName 表格中列出的指令名稱， elementId 是要在其上執行指令之系統的完整名稱。及 arguments 是表格中列出的指令特定引數。
```
{
  "orders": [
    {
   "commandName" : "command",
   "elementId" : "system name",
   "arguments" : command arguments
    },
    :
    :
  ]
}
```
例如，對於不接受任何引數的 refreshStaus 指令:
```
{
  "orders": [
    {
   "commandName" : "refreshStatus",
   "elementId" : "system-name.com"
    },
    :
    :
  ]
}
```

按一下執行。

Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。

Response body

{
  "KBM_TYPE": "commandHandlerResponse",
  "results": [
    {
      "KBM_TYPE": "result",
      "elementId": "system-name.com",
      "commandName": "refreshStatus",
      "resultKey": "OK",
      "result": "4"
    }
  ]
}

Swagger POST /command/results 範例

提交結果指令以執行。

請執行下列步驟來執行 API。

展開指令區段。
按一下 POST /command/results。
按一下試用。
從下拉功能表中選取媒體類型。這會控制 curl 指令中的標頭接受類型。可能的值為 application/json 和 application/xml。

決定您想要的結果狀態。結果狀態會顯示在 POST /command API 呼叫的回應中。例如：

Response body

{
  "KBM_TYPE": "commandHandlerResponse",
  "results": [
    {
      "KBM_TYPE": "result",
      "elementId": "system-name.com",
      "commandName": "refreshStatus",
      "resultKey": "OK",
      "result": "4" <-- 
    }
  ]
}

請以下列格式提供要求內文:
```
{
  "keys": [
    "4"
  ]
}
```

按一下執行。

Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。


Response body
{
  "KBM_TYPE": "commandResultsHandlerResponse",
  "results": {
    "4": {
      "uid": "6681249854347280387",
      "commandName": "refreshStatus",
      "bestName": "system-name.com",
      "resultKey": "OK",
      "result": ""
    }
  }
}

Swagger GET/timelineEvents 範例

依事件類型取得事件清單。

請執行下列步驟來執行 API。

展開指令區段。
按一下 POST/timelineEvents。
按一下試用。
從下拉功能表中選取媒體類型。這會控制 curl 指令中的標頭接受類型。可能的值為 application/json 和 application/xml。
在文字框中輸入 UID 或主機名稱，然後按一下新增項目。再按一下新增項目，以指定其他系統。
在 groupName 文字框中輸入現有群組的名稱。
選擇性地按一下 includeHidden ，並將它設為 true ，以併入隱藏事件。隱藏事件不會以其他方式包含在事件數目中。
在 fromDate 欄位中以格式 MM/DD/YYYY 指定起始日期。您可以修改日期來增加或減少時間範圍。
在 toDate 欄位中指定結束日期，格式為 MM/DD/YYYY。您可以修改日期來增加或減少時間範圍。
在 eventTypes 欄位中選取要接收的事件類型。您可以控制報告中顯示的事件。事件類型包括 RTC、Auditd、TE、Compliance 及 UpToDate。
按一下執行。
Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。

Swagger POST /黑板範例

在指定時段隱藏、取消隱藏或刪除事件。

請執行下列步驟來執行 API。

展開指令區段。
按一下 POST /黑板範例。
按一下試用。
在文字框中輸入 UID 或主機名稱，然後按一下新增字串項目。再按一下新增字串項目，以指定其他系統。
在 groupName 文字框中輸入現有群組的名稱，然後按一下新增字串項目。再次按一下新增字串項目，以指定其他群組。
按一下隱藏，並將它設為 true ，以隱藏事件。或者，按一下刪除，並將它設為 true ，以刪除事件。您不可同時指定這二者。
在 fromDate 欄位中以格式 MM/DD/YYYY 指定起始日期。您可以修改日期來增加或減少時間範圍。
在 toDate 欄位中指定結束日期，格式為 MM/DD/YYYY。您可以修改日期來增加或減少時間範圍。
指定事件 ID 以僅影響該事件。您可以使用 Swagger GET /黑板範例來取得現行事件 ID。
按一下執行。
Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。

Swagger GET /黑板範例

取得事件清單。

請執行下列步驟來執行 API。

展開指令區段。
按一下 GET /黑板範例。
按一下試用。
在文字框中輸入 UID 或主機名稱，然後按一下新增字串項目。再按一下新增字串項目，以指定其他系統。
在 groupName 文字框中輸入現有群組的名稱，然後按一下新增字串項目。再次按一下新增字串項目，以指定其他群組。
如果您想要取得與事件相關聯的詳細資料，請按一下 varmap 並將它設為 true。
如果您想要併入隱藏事件，請按一下 includeHidden 。
僅針對 AUDITD_CONTENT_CHANGED 事件，按一下 identityVar值，以提供特定 AUDITD_CONTENT_CHANGED 事件的其他精度。例如，如果 PowerSC GUI 在 Auditd: Content Changed 事件的詳細資料中顯示 /test/test1.txt ，請在 identityVar值欄位中指定 /test/test1.txt 。
按一下 categoryId 並指定事件種類，以僅取得特定種類的事件。若要從現有事件取得可能的種類值，請執行下列步驟:
1. 請勿指定 categoryId。
2. 執行 GET /黑板範例。
3. 從回應中取得種類值。
按一下限制，以設定要傳回的事件數上限。
按一下執行。
Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。

Swagger GET/ruleFailures 範例

取得失敗相符性規則的清單。

請執行下列步驟來執行 API。此程序會先執行 checkCompliance 指令，以檢查規則失敗的相符性層次。

展開指令區段。
按一下 POST /command。
按一下試用。
從下拉功能表中選取媒體類型。這會控制 curl 指令中的標頭接受類型。可能的值為 application/json 和 application/xml。
以下列格式指定要求內文，其中 checkCompliance 會檢查相符性層次 (如 https://server-name/ws/powerscui/command中的 commandName 表格所述) ，而 elementId 是要執行指令之系統的完整名稱。
```
{
  "orders": [
   
    {
      "commandName": "checkCompliance",
      "elementId": "system name"   
    }        
    ]
}
```
按一下執行。
Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。
按一下 GET/ruleFailures。
按一下試用。
在文字框中輸入 UID 或主機名稱。按一下新增項目以指定其他系統。
在 groupName 文字框中輸入現有群組的名稱。
將作業控制項設為空值，以取得前次檢查之設定檔的任何失敗規則。選擇相容性，以針對您在 PowerSC 圖形使用者介面 (GUI)中執行的前次模擬設定檔檢查，取得任何失敗的規則。
從下拉功能表中選取媒體類型。這會控制 curl 指令中的標頭接受類型。可能的值為 application/json 和 application/xml。

按一下執行。

Swagger 使用者介面會提交要求，並顯示已提交的 curl 指令。如果成功，回應區段會顯示 HTTP 狀態碼為 200 OK 的回應。


Response body
{
  "KBM_TYPE": "root",
  "tuples": [
    {
      "KBM_TYPE": "tuple",
      "uid": "6692429250491842561",
      "bestName": "system name",
      "operation": "check",
      "logEntryTimestamp": 1595605256000,
      "complianceLevel": "CISv1",
      "ruleName": "cisv1_telnet_0DA0C685",
      "ruleDescription": "Implements CIS Recommendations AIX6.1-1.3.24 and AIX7.1-3.3.24 (Level 1): 
          Disable telnet in /etc/inetd.conf: Comments the entry for telnet daemon in /etc/inetd.conf 
            and kills all instances of telnetd.",
      "argumentsPassed": "/etc/security/pscexpert/bin/cominetdconf telnet tcp d cisv1_telnet",
      "ruleStatus": false,
      "reasonForFailure": " Service telnet using protocol tcp should be disabled, however it is 
             now enabled.\n"
    },
 :
 :