Vdom

Configuration endpoint for system/vdom.

Python Attribute

fgt.api.cmdb.system.vdom

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.get()

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

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

# Update existing item
result = fgt.api.cmdb.system.vdom.put(
    name='updated-value',
    short_name='updated-value',
    vcluster_id='updated-value',
    flag='updated-value',
)

# Delete item
result = fgt.api.cmdb.system.vdom.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,
    short_name=None,
    vcluster_id=None,
    flag=None,
    vdom=None,
    raw_json=False,
    **kwargs
)

Create object(s) in this table.

put()

put(
    name=None,
    payload_dict=None,
    before=None,
    after=None,
    short_name=None,
    vcluster_id=None,
    flag=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.