Skip to content

docs(auditor): verify and correct permissions for NetApp Auditing [Doc Task 439286]#1027

Merged
nwnikacc merged 15 commits into
devfrom
fix/issue-439286-netapp-permissions
May 28, 2026
Merged

docs(auditor): verify and correct permissions for NetApp Auditing [Doc Task 439286]#1027
nwnikacc merged 15 commits into
devfrom
fix/issue-439286-netapp-permissions

Conversation

@nwnikacc
Copy link
Copy Markdown
Contributor

Summary

  • Moved Remember note about vsadmin to a dedicated section at the bottom of the page with expanded description
  • Added ONTAPI vs. REST API section with guidance on when to use each protocol, including the AD group limitation in ONTAP 9.10+
  • Added NetApp Built-in vsadmin Role section with when-to-use / when-to-prefer-granular-roles guidance
  • Moved NetApp documentation links to a Related Resources section
  • Removed duplicate NOTE from Step 3 of Create Role procedure (now covered by the new ONTAPI vs. REST API section)

Test plan

  • Verify all internal anchor links resolve correctly
  • Verify NetApp external links are reachable
  • Review formatting of NOTE: blocks and tables

Relates to: Doc Task 439286 — [FSA] Verify and correct the "Permissions for NetApp Auditing" doc

Generated with AI

Co-Authored-By: Claude Code ai@netwrix.com

nwnikacc and others added 8 commits May 28, 2026 20:09
Moved the _Remember_ inline note about the vsadmin role from mid-page
to a dedicated section at the end of the file. Expanded the description
to explain why vsadmin works (full SVM admin access, covers all Netwrix
Auditor API requirements) and added a link to the official NetApp ONTAP
documentation for predefined SVM administrator roles.

Relates to: Doc Task 439286 — [FSA] Verify and correct the "Permissions for NetApp Auditing" doc

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Added When to use / When to prefer granular roles guidance.
Moved NetApp docs link to a Related Resources section.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
…tive

Changed heading from imperative to noun phrase and rewrote
body/bullet points in neutral third-person to avoid reading
as a recommendation or call to action.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
…granular roles

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
…rces

- Added new ONTAPI vs. REST API section before Create Role procedure
  with guidance on when to use each protocol and a note about AD group
  limitation in ONTAP 9.10+
- Removed duplicate NOTE from Step 3 in Create Role; replaced with
  cross-reference to the new section
- Moved link descriptions into link text in Related Resources
- Added NetApp ONTAP Automation docs link for REST API migration

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@nwnikacc nwnikacc requested a review from a team as a code owner May 28, 2026 18:40
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

11 issues fixed, 1 skipped across 1 files

Category Fixes
Contractions 2
BoilerplateCrossRef (rewrite) 1
Dale: idioms 2
Dale: passive-voice 6
Skipped (needs manual review) Reason

| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:12 — Dale: undefined-acronyms | SVM and ONTAPI are NetApp-specific acronyms used without spelled-out form on first use, but in a NetApp configuration article the target audience (NetApp/Auditor admins) is reliably familiar with them; expanding them mid-prose would change the article's voice and scope beyond a Dale fix |

Ask @claude on this PR if you'd like an explanation of any fix.

@nwnikacc
Copy link
Copy Markdown
Contributor Author

nwnikacc commented May 28, 2026

Fix complete:

  • Introduce ZAPI synonym in opening sentence (line 59)
  • Fix "modern ONTAP versions" vague qualifier (line 68)
  • Remove duplicate REST API link — kept only in Related Resources (line 73)
  • Add forward reference for netwrix_role / netwrix_rest_role in NOTE (line 71)
  • Add vsadmin forward pointer in ONTAPI vs. REST API section
  • Clarify AD domain account bullet reason (line 159)
  • Commit and push

Summary:

  • docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md: 6 editorial issues fixed. Issue 5 (idiom "rule out") was already resolved by the Vale/Dale auto-fix workflow.

- Introduce ZAPI as synonym for ONTAPI in opening sentence
- Replace vague "modern ONTAP versions" with "from ONTAP 9.10 onward"
- Add forward references for netwrix_role/netwrix_rest_role in NOTE
- Remove duplicate Migrate to REST API link (kept in Related Resources only)
- Add vsadmin forward pointer in ONTAPI vs. REST API section
- Clarify AD domain account bullet with explicit reason

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

3 issues fixed, 3 skipped across 1 files

Category Fixes
Dale: passive-voice 1
Dale: positional-references 1
Dale: undefined-acronyms 1
Skipped (needs manual review) Reason

| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:73 — Dale: minimizing-difficulty | 'A simple setup' describes an attribute of the configuration approach, not the difficulty of a user task |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:151 — Dale: minimizing-difficulty | 'A simple setup' describes the configuration approach as a characteristic, not minimizing user task difficulty |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:48 — Dale: undefined-acronyms | 'RestAPI' / 'RESTAPI' is a stylistic/consistency issue (should be 'REST API'); REST is a well-known IT term familiar to sysadmin audiences |

Ask @claude on this PR if you'd like an explanation of any fix.

@andrey-isakov-nwx
Copy link
Copy Markdown
Contributor

[Low] Inconsistent "RESTAPI" vs "REST API" terminology

Pre-existing lines in the Create Role section still use RESTAPI (no space) while all new sections added by this PR use REST API (with space):

  • Line 82: netwrix_rest_role for RESTAPI
  • Line 95 heading: Create RESTAPI role:
  • Line 121 heading: RESTAPI role:
  • Line 137 heading: Create login for RESTAPI role:

Suggested fix: Replace RESTAPIREST API in the Create Role section (headings and inline references) to match the terminology used throughout the rest of the page.

@andrey-isakov-nwx
Copy link
Copy Markdown
Contributor

[Low] vsadmin section lacks upfront privilege warning

The section opens by saying the role "grants full SVM administrative access" but places the security guidance only in the "Granular roles are preferable when" bullet list below. A reader skimming for a simple setup may choose vsadmin in a production environment without reading the caveat.

Suggested fix: Add a NOTE before the bullet lists, e.g.:

NOTE: The vsadmin role grants broad SVM administrative privileges beyond what Netwrix Auditor requires. Use granular custom roles in production environments following the least-privilege principle.

@andrey-isakov-nwx
Copy link
Copy Markdown
Contributor

[Low] AD domain account bullet in granular-roles section lacks explanation

Line 159: "You use an AD domain account for data collection (see Create Role…)" links to the procedure but does not explain why AD accounts require granular roles — readers must follow the link and infer.

Suggested fix: Expand to: "You use an AD domain account for data collection — AD accounts must be assigned a custom role because the vsadmin role cannot be directly assigned to domain accounts via the ONTAPI/HTTP login mechanism (see Create Role on NetApp Clustered Data ONTAP 8 or ONTAP 9 and Enabling AD User Access)."

- Fix intro paragraph to acknowledge both ONTAPI and REST API protocols
- Replace RESTAPI → REST API throughout (headings and inline references)
- Clarify vague "The choice" subject in ONTAPI vs. REST API section
- Remove forward references to role names in NOTE before they are introduced
- Rewrite "simple setup" sentence for clarity
- Add security NOTE before vsadmin bullet lists
- Fix parallel structure in vsadmin troubleshooting bullet
- Update "least-privilege principle" → "principle of least privilege"
- Expand AD domain account bullet with explanation of why granular roles are required

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 3 skipped across 1 files

Category Fixes
Dale: passive-voice 1
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:12 — Dale: undefined-acronyms | ONTAPI is a product name (ONTAP API) and is explained in the cross-referenced section that follows; spelling out inline would be redundant |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:152 — Dale: wordiness | 'There are no restrictions on using a highly privileged SVM account' — rewording could alter the precise meaning of the constraint being described |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:73 — Dale: headings (style guidance) | Heading mixes imperative 'Create' and gerund 'Enabling'; not covered by a Dale rule, and rewording could change established anchor structure |

Ask @claude on this PR if you'd like an explanation of any fix.

Address inline reviewer comment: the existing ONTAPI criteria could be
misread by ONTAP 9.10+ users. Added sentence clarifying that ONTAPI is
still supported on 9.10+ for backward compatibility but REST API is
recommended for new deployments.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

1 issues fixed, 3 skipped across 1 files

Category Fixes
Dale: passive-voice 1
Skipped (needs manual review) Reason

| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:57 — Dale: passive-voice | '(also known as ZAPI)' is a fixed parenthetical expression; rewriting would change tone and clarity. |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:147 — Dale: misplaced-modifiers | 'Use granular custom roles in production environments following the principle of least privilege' has a participial phrase that could attach to either 'environments' or the implied 'you'; meaning is clear in context and rewrites risk altering nuance. |
| docs/auditor/10.8/configuration/fileservers/netappcmode/permissions.md:158 — Dale: passive-voice | 'The SVM is shared' uses 'shared' as a stative adjective describing SVM configuration; rewriting to specify an agent would change meaning. |

Ask @claude on this PR if you'd like an explanation of any fix.

@nwnikacc nwnikacc merged commit 5add46d into dev May 28, 2026
9 checks passed
@nwnikacc nwnikacc deleted the fix/issue-439286-netapp-permissions branch May 28, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants