Skip to content

Commit

Permalink
Reflecting spec to help.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rmurray-r7 committed Jan 6, 2025
1 parent 0696a92 commit d5f05c3
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 14 deletions.
6 changes: 3 additions & 3 deletions plugins/rapid7_insight_agent/.CHECKSUM
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"spec": "b8b7370c8f21f0adcc0684545a186a56",
"spec": "3ea8076dfb3cb04ad6239462632ca27e",
"manifest": "fbc1b04c51c6c8816dac6cee216341c2",
"setup": "7f65232e4808ae89ad79c06f1b2dc5a2",
"schemas": [
Expand All @@ -9,11 +9,11 @@
},
{
"identifier": "get_agent_details/schema.py",
"hash": "5b09dc2d9e61e0d0f0ebedfab722b120"
"hash": "8b95862344f318fbe4593d8c9710caef"
},
{
"identifier": "get_all_agents_by_ip/schema.py",
"hash": "02cda219f562d328ac60a9540c79d3a5"
"hash": "8c5c177cfaf437d557a9af2b9eaa97d7"
},
{
"identifier": "quarantine/schema.py",
Expand Down
2 changes: 2 additions & 0 deletions plugins/rapid7_insight_agent/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ LABEL sdk=python

WORKDIR /python/src



ADD ./plugin.spec.yaml /plugin.spec.yaml
ADD ./requirements.txt /python/src/requirements.txt

Expand Down
14 changes: 8 additions & 6 deletions plugins/rapid7_insight_agent/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,9 @@ Example output:
```

#### Get Agent Details

This action is used to find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor

This action is used to find and display detailed information about a device. If additional pages of agents are
available, the action should be run again with the returned next cursor

##### Input

Expand Down Expand Up @@ -142,8 +143,9 @@ Example output:
```

#### Get All Agents by IP Address

This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor

This action is used to find all agents that share the same public or private IP address and display details about them.
If additional pages of agents are available, the action should be run again with the returned next cursor

##### Input

Expand Down Expand Up @@ -453,9 +455,9 @@ Example output:
|Hostname|string|None|False|Hostname|None|


## Troubleshooting
# Troubleshooting

If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found.
* If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found.

# Version History

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


class Component:
DESCRIPTION = "Find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor"
DESCRIPTION = "This action is used to find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor"


class Input:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


class Component:
DESCRIPTION = "Find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor"
DESCRIPTION = "This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor"


class Input:
Expand Down
7 changes: 4 additions & 3 deletions plugins/rapid7_insight_agent/plugin.spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ key_features:
requirements:
- "[Platform API Key](https://docs.rapid7.com/insight/managing-platform-api-keys/)"
- "Administrator access to InsightIDR"
troubleshooting: "If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found."
troubleshooting:
- "If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found."
links:
- "[Rapid7 Insight Agent](https://docs.rapid7.com/insight-agent/overview/)"
references:
Expand Down Expand Up @@ -290,7 +291,7 @@ actions:
required: false
get_agent_details:
title: Get Agent Details
description: Find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor
description: "This action is used to find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor"
input:
agent:
title: Agent
Expand Down Expand Up @@ -319,7 +320,7 @@ actions:
example: 9de5069c5afe602b2ea0a04b66beb2c0
get_all_agents_by_ip:
title: Get All Agents by IP Address
description: Find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor
description: This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor
input:
ip_address:
title: IP Address
Expand Down

0 comments on commit d5f05c3

Please sign in to comment.