Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugin.spec reflecting help.md (Rapid7 Insight Agent) #3029

Merged
merged 3 commits into from
Jan 7, 2025
Merged

Plugin.spec reflecting help.md (Rapid7 Insight Agent) #3029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3d4a18
Reflecting spec to help.md
rmurray-r7 Jan 6, 2025
85dbd8e
troubleshooting header
rmurray-r7 Jan 6, 2025
a4a6515
Update plugin.spec
rmurray-r7 Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions plugins/rapid7_insight_agent/.CHECKSUM
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"spec": "b8b7370c8f21f0adcc0684545a186a56",
"spec": "068f90d6f4a93addc62a6c00ad1aa085",
"manifest": "fbc1b04c51c6c8816dac6cee216341c2",
"setup": "7f65232e4808ae89ad79c06f1b2dc5a2",
"schemas": [
Expand All @@ -13,7 +13,7 @@
},
{
"identifier": "get_all_agents_by_ip/schema.py",
"hash": "02cda219f562d328ac60a9540c79d3a5"
"hash": "8c5c177cfaf437d557a9af2b9eaa97d7"
},
{
"identifier": "quarantine/schema.py",
Expand Down
10 changes: 6 additions & 4 deletions plugins/rapid7_insight_agent/help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ 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 @@ -455,7 +457,7 @@ Example output:

## 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
2 changes: 1 addition & 1 deletion ...ins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py
View file
Open in desktop
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
5 changes: 3 additions & 2 deletions plugins/rapid7_insight_agent/plugin.spec.yaml
View file
Open in desktop
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 @@ -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
Loading