Skip to main content
Glama
vmware-skills

vmware-storage

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

storage_iscsi_add_target

Add an iSCSI dynamic discovery target to an ESXi host's software adapter, then rescan HBAs and VMFS volumes to discover new LUNs. Preview the impact before applying changes.

Instructions

[WRITE] Add an iSCSI send (dynamic discovery) target to an ESXi host's software iSCSI adapter, then automatically rescan all HBAs and VMFS volumes to discover new LUNs.

Without confirm=True this only previews: it returns blast_radius (the adapter, the send targets configured now, and the adapters the rescan touches) and changes nothing. Show it to the user. Do not set confirm=True on your own because the user asked earlier — they have not seen the preview yet. Refused when software iSCSI is not enabled (run storage_iscsi_enable first) or the host's storage view cannot be read. A duplicate address:port returns action "noop". No separate storage_rescan call is needed afterwards. Returns a dict.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portNoiSCSI TCP port, 1-65535 (default 3260).
targetNoOptional vCenter/ESXi target name from config.
addressYesiSCSI portal IP address (IPv4/IPv6 literal; hostnames are rejected with a validation error).
confirmNoFalse (default) returns the blast radius and changes nothing. True applies it.
dry_runNoDeprecated alias for confirm; removed in the next minor release. dry_run=False acts, dry_run=True previews.
host_nameYesESXi host name as shown in vCenter inventory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.11.0
    • addedInput schema / properties / confirm
      Added value: +{
+  "default": false,
+  "description": "False (default) returns the blast radius and changes nothing. True applies it.",
+  "title": "Confirm",
+  "type": "boolean"
+}
    • addedInput schema / properties / dry_run / anyOf
      Added value: +[
+  {
+    "type": "boolean"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / dry_run / default
      Previous value: -falseNew value: +null
    • changedInput schema / properties / dry_run / description
      Previous value: -"If true, return a preview of the change without executing it."New value: +"Deprecated alias for confirm; removed in the next minor release. dry_run=False acts, dry_run=True previews."
    • removedInput schema / properties / dry_run / type
      Removed value: -"boolean"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "title": "Result",
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "storage_iscsi_add_targetOutput",
-  "type": "object"
-}New value: +null
  2. Changed6 schema fields changedv1.8.15
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / address / description
      Added value: +"iSCSI portal IP address (IPv4/IPv6 literal; hostnames are rejected with a validation error)."
    • addedInput schema / properties / dry_run / description
      Added value: +"If true, return a preview of the change without executing it."
    • addedInput schema / properties / host_name / description
      Added value: +"ESXi host name as shown in vCenter inventory."
    • addedInput schema / properties / port / description
      Added value: +"iSCSI TCP port, 1-65535 (default 3260)."
    • addedInput schema / properties / target / description
      Added value: +"Optional vCenter/ESXi target name from config."
  3. Changed1 schema field changedv1.6.0
    • addedInput schema / properties / dry_run
      Added value: +{
+  "default": false,
+  "title": "Dry Run",
+  "type": "boolean"
+}
  4. First observedv1.3.2

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description fully discloses the preview behavior with blast_radius, the rescan of HBA/VMFS, and the noop for duplicates. It also explains refusal conditions (software iSCSI not enabled, storage view unreadable). Annotations are minimal, so the description carries the burden and does so well.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is rich but each sentence serves a purpose. Key items (write action, impact) are front-loaded. It avoids verbosity, though it is a bit long; every sentence is procedural and critical for correct invocation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (6 params, dual-mode), the description is complete. It covers the required confirmation flow, failure conditions, side effects, and return type. No output schema exists, but the description states it returns a dict, which is enough for an agent to proceed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 100% coverage, so all parameters are documented. The description adds clarity on the confirm/dry_run relationship and the address restriction to IP literals. It doesn't need to repeat parameters but could have noted the default port behavior; still, the schema covers it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states that the tool adds an iSCSI send target, then rescans. It also specifies the resource (software iSCSI adapter). The [WRITE] prefix and explicit mention of the confirm workflow distinguishes it from siblings like storage_iscsi_status and storage_rescan.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly instructs when to use confirm=False first, warns not to set confirm=True autonomously, names storage_iscsi_enable as a prerequisite, and states that no separate storage_rescan is needed. It also smallnotes the duplicate address:port behavior, which prevents redundant tries.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools