Bases: BaseEndpoint
Endpoint to manage IP interfaces on an Alcatel-Lucent OmniSwitch using CLI-based API calls.
create(if_name, address=None, vip_address=None, mask=None, admin_state=None, vlan=None, service=None, forward=None, local_proxy_arp=None, encapsulation=None, primary=None)
Create a new IP interface with specified parameters.
| Parameters: |
-
if_name
(str)
–
-
address
(Optional[str], default:
None
)
–
-
vip_address
(Optional[str], default:
None
)
–
-
mask
(Optional[str], default:
None
)
–
-
admin_state
(Optional[str], default:
None
)
–
Interface admin state, either ‘enable’ or ‘disable’.
-
vlan
(Optional[int], default:
None
)
–
-
service
(Optional[int], default:
None
)
–
-
forward
(Optional[bool], default:
None
)
–
Enable or disable packet forwarding.
-
local_proxy_arp
(Optional[bool], default:
None
)
–
Enable or disable local proxy ARP.
-
encapsulation
(Optional[str], default:
None
)
–
Encapsulation type (‘e2’ or ‘snap’).
-
primary
(Optional[bool], default:
None
)
–
Set as primary interface.
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the creation operation or error response.
|
delete(if_name)
Delete an existing IP interface.
| Parameters: |
-
if_name
(str)
–
Name of the interface to delete.
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the deletion operation or error response.
|
edit(if_name, address=None, vip_address=None, mask=None, admin_state=None, vlan=None, service=None, forward=None, local_proxy_arp=None, encapsulation=None, primary=None)
Edit an existing IP interface with updated parameters.
| Parameters: |
-
if_name
(str)
–
-
address
(Optional[str], default:
None
)
–
-
vip_address
(Optional[str], default:
None
)
–
-
mask
(Optional[str], default:
None
)
–
-
admin_state
(Optional[str], default:
None
)
–
Interface admin state, either ‘enable’ or ‘disable’.
-
vlan
(Optional[int], default:
None
)
–
-
service
(Optional[int], default:
None
)
–
-
forward
(Optional[bool], default:
None
)
–
Enable or disable packet forwarding.
-
local_proxy_arp
(Optional[bool], default:
None
)
–
Enable or disable local proxy ARP.
-
encapsulation
(Optional[str], default:
None
)
–
Encapsulation type (‘e2’ or ‘snap’).
-
primary
(Optional[bool], default:
None
)
–
Set as primary interface.
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the edit operation or error response.
|
list()
Retrieve a list of all configured IP interfaces.
| Returns: |
-
ApiResult –
The result object containing parsed output of the command show ip interface.
|