Get /policy/logical-network-configuration/element/properties
Description
Returns all topology properties required to configure a device and the current configuration.
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiNAC |
| Content-Type (option 1) | application/json | String | |
|
Content-Type (option 2) |
application/xml |
|
|
Request Body Parameters
|
Name |
Required |
Type |
|---|---|---|
| deviceID | Required | Integer |
|
readFromDevice |
Optional |
Boolean |
Sample Request
|
Request URL |
Get https://10.106.94.152:8443/api/v2/policy/logical-network-configuration/element/properties |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json
|
|
Request Body |
deviceID: xxxxxxxx |
Sample Response
{
"status": "string",
"errorMessage": "string",
"vlanNames": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"vlanIDs": [
0
],
"radiusNames": [
"string"
],
"defaultPrimaryRadiusName": "string",
"defaultSecondaryRadiusName": "string",
"sourceIPAddr": "string",
"configs": {
"wiredDevice": true,
"wirelessDevice": true,
"wirelessController": true,
"usesIPPhones": true,
"usesEnable": true,
"usesSSH": true,
"useWiredAttributeForWireless": true,
"supportsRadius": true,
"hybridDevice": true,
"supportsMobilityVlan": true,
"excludeVlan": true,
"includeCaptivePortal": true,
"manageWebAuth": true,
"usesDisassociatePort": true,
"usesGuestVlan": true,
"usesSessionType": true,
"usesRoles": true,
"rfc5176Enabled": true,
"supportsForwardingTable": true,
"portChannelSupport": true,
"supportsVlanName": true,
"specialDevice": true,
"noVoiceVLAN": true,
"supportsFirewallTags": true,
"usesVDOM": true,
"supportsVPNAddressGroups": true,
"supportsSSOAddressGroups": true,
"devType": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"user_1": "string",
"telnetPW_1": "string",
"enablePW_1": "string",
"sessionID": "string",
"wapDomain": "string",
"chassisIPAddr": "string",
"slotLetter": "string",
"portMode": "string",
"EAPTerminate": "string",
"snmpVersion": "string",
"disassociatePort": "string",
"usesCLIConfiguration": "string",
"chassisConfiguration": "string",
"deadVlan": "string",
"quarantineVlan": "string",
"unregVlan": "string",
"defaultVlan": "string",
"voiceVlan": "string",
"authVlan": "string",
"guestVlan": "string",
"devMode": "string",
"opMode": "string",
"transMethod": "string",
"mobilityGroup": "string",
"mobilityVlan": "string",
"vlanNames": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"credentials": {
"version": 0,
"userName": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"cliTimeout": "string",
"cliConnectTimeout": "string",
"routerCredentials": {
"version": 0,
"userName": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"vlanFormat": "string",
"isClientBasedCLI": true,
"dot1xAutoRegister": true,
"defaultConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"defaultWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"registrationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"registrationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"remediationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"remediationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"authenticationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"authenticationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"deadEndConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"deadEndWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"guestConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string",
"sendGroupsToFirewall": true,
"tags": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.311Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"firewallGroups": [
0
]
},
"voiceVlanID": "string",
"chassisIP": "string",
"chassisSlot": "string",
"sessionID": "string",
"radiusEnabled": true,
"radiusMode": "string",
"radiusSecret": "string",
"primaryRadiusName": "string",
"secondaryRadiusName": "string",
"radiusServerConfigId": 0,
"radiusServerConfigs": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
],
"config": {
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.312Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.312Z",
"id": 0,
"name": "pygn@<c*eYX#=#DW2@=!q \\x70'kG7Y{OGq|w7SE\"814t2&085`e67\\.rVh+x,=sFqG\"q=[ H7ZY",
"description": "string",
"guid": 0,
"globalModifiedDate": "2023-11-28T02:56:12.312Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-28T02:56:12.312Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2023-11-28T02:56:12.312Z",
"elementId": 0,
"logicalNetworkID": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"networkID": 0,
"task": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
},
"accessValue": "string",
"yamsEventTag": "string",
"accessActionStr": "string",
"logicalNetworkName": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
},
"ConfigList": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.312Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-28T02:56:12.313Z",
"id": 0,
"name": "%7b#xT\\U3:8R&D({|hI2py{uI.vY9\"JJ)l",
"description": "string",
"guid": 0,
"globalModifiedDate": "2023-11-28T02:56:12.313Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-28T02:56:12.313Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2023-11-28T02:56:12.313Z",
"elementId": 0,
"logicalNetworkID": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"networkID": 0,
"task": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
},
"accessValue": "string",
"yamsEventTag": "string",
"accessActionStr": "string",
"logicalNetworkName": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
}
],
"vdom": "string",
"portChannelSupport": true,
"usePortChannels": true,
"useSecurePorts": true,
"disassociatePort": "string",
"manageWebAuthMode": true,
"wapDomain": "string",
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"applyDefaultToPorts": true,
"vpnAddressGroup": "string",
"ssoAddressGroup": "string"
}