Category: Share Access#

The Share Access category documents which network shares an object accesses. It is a multi-value category — any number of share access entries can be created, e.g. when a client accesses multiple file server shares. The category represents the reverse relationship to the category Shares: While Shares on the server documents which shares it provides, Share Access on the client shows which shares it consumes.

Usage#

Typical use cases:

• Document client configuration: Record for each client which network drives are mapped and where they are mounted (mountpoint). This is especially valuable during troubleshooting when a user cannot access "their drive" — a glance at i-doit immediately shows which server and which share is affected.
• Impact analysis during server maintenance: Using the Report Manager, you can evaluate which clients access the shares of a specific server. Before planned maintenance, affected users can be specifically informed.
• Migration and relocation: When migrating file servers, a report on all share accesses shows which clients need to be reconfigured. No client is forgotten, no mountpoint overlooked.
• License and compliance review: In some cases, access to certain shares is license-relevant (e.g. software repositories). The documentation in i-doit creates transparency.

Fields#

Selected object#

Link to the server object on which the share resides. Object browser field — select here the file server or NAS whose share is being accessed.

Mountpoint#

The local mount point under which the share is available on the client, e.g. Z: (Windows drive letter) or /mnt/data (Linux). This field is crucial for troubleshooting — users often only know the drive letter, not the UNC path.

Share name#

The name of the share on the server, e.g. Data$ or Projects. Dialog field that offers the shares created on the linked server object in the category Shares for selection.

Description#

Free text for additional details: access permissions (read/write), group policies that connect the drive, or notes on usage.

Technical Reference#

Fields (API Reference)#

API Examples#

Create Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 456,
        "category": "C__CATG__SHARE_ACCESS",
        "data": {
            "assigned_objects": 123,
            "mountpoint": "P:",
            "shares": "Projects",
            "description": "Project drive, access via AD group GRP_Projects_RW"
        }
    },
    "id": 1
}

Read Entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "object": 456,
        "category": "C__CATG__SHARE_ACCESS"
    },
    "id": 2
}

Update Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 456,
        "category": "C__CATG__SHARE_ACCESS",
        "entry": 7,
        "data": {
            "mountpoint": "Q:",
            "description": "Drive letter changed: P: to Q: due to conflict with printer port."
        }
    },
    "id": 3
}