HFortix-FortiOS
  • Quick Start Guide
  • Authentication
  • User Guide
  • Methods and Usage
  • API Endpoints
    • Quick Navigation
      • CMDB
        • Categories
        • Quick Start
        • All Categories
      • MONITOR
      • LOG
      • SERVICE
    • API Overview
    • Usage Examples
  • API Reference
  • Topic Guides
  • Code Examples
HFortix-FortiOS
  • API Endpoints
  • CMDB
  • System
  • VdomLink
  • Edit on GitHub

VdomLink

Configuration endpoint for system/vdom_link.

Python Attribute

fgt.api.cmdb.system.vdom_link

Available Methods

  • get() - GET operation

  • post() - POST operation

  • put() - PUT operation

  • delete() - DELETE operation

Examples

from hfortix_fortios import FortiOS

fgt = FortiOS(host='192.168.1.99', token='your-token')

# List all items
items = fgt.api.cmdb.system.vdom_link.get()

# Get specific item by name
item = fgt.api.cmdb.system.vdom_link.get(name='item-name')

# Create new item
result = fgt.api.cmdb.system.vdom_link.post(
    nkey='value',  # optional
    name='value',  # optional
    vcluster='value',  # optional
)

# Update existing item
result = fgt.api.cmdb.system.vdom_link.put(
    name='updated-value',
    vcluster='updated-value',
    type='updated-value',
)

# Delete item
result = fgt.api.cmdb.system.vdom_link.delete(name='item-name')

Method Reference

get()

get(
    name=None,
    payload_dict=None,
    attr=None,
    skip_to_datasource=None,
    acs=None,
    search=None,
    vdom=None,
    raw_json=False,
    **kwargs
)

Select a specific entry from a CLI table.

post()

post(
    payload_dict=None,
    nkey=None,
    name=None,
    vcluster=None,
    type=None,
    vdom=None,
    raw_json=False,
    **kwargs
)

Create object(s) in this table.

put()

put(
    name=None,
    payload_dict=None,
    before=None,
    after=None,
    vcluster=None,
    type=None,
    vdom=None,
    raw_json=False,
    **kwargs
)

Update this specific resource.

delete()

delete(
    name=None,
    payload_dict=None,
    vdom=None,
    raw_json=False,
    **kwargs
)

Delete this specific resource.

Previous Next

© Copyright 2026, Herman W. Jacobsen.

Built with Sphinx using a theme provided by Read the Docs.