User (STRUCT) ¶ TYPE User : STRUCT SNMP V3 User InOut: Name Type Initial Comment sName STRING Name of the user sAuthPwd STRING(64) Authentification password sPrivPwd STRING(64) Encryption password eAuthMethod AuthMethods Authentification method ePrivMethod PrivMethods Encryption method eAccessType AccessType AccessType.ReadOnly ReadOnly (SET not allowed) or ReadWrite (SET allowed), default: ReadOnly
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 14.08.2024, 09:22:53 companyName string 3S-Smart Software Solutions GmbH libraryFile SNMP Service SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SNMP Service SL.clean.json version version 2.0.0.0 ProjectInformation ActivateDongleLicensing bool False IsEndUserLibrary True OnlineHelp True Released True LastModificationDateTime date 14.08.2024, 09:22:51 FirmCode int 101597 ProductCode 8711 LibraryCategories library-category-list Application|Utils ActivationMail string support@codesys.com ActivationUrl http://license.codesys.com AlternativeFirmCodes 5000304 Author CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace SNMP Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder SNMP_Service_SL Project SNMP Service SL Title SNMP Service SL Version version 1.11.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CmpCrypto ¶ Library Identification ¶ Placeholder: CmpCrypto Default Resolution: CmpCrypto, * (System) Namespace: CmpCrypto Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager Net Base Services ¶ Library Identification ¶ Placeholder: NetBaseSrv Default Resolution: Net Base Services, * (3S - Smart Software Solutions GmbH) Namespace: NBS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: NetBaseSrv Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSocket ¶ Library Identification ¶ Placeholder: SysSocket Default Resolution: SysSocket, * (System) Namespace: SOCK Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: SysSocket SysTarget ¶ Library Identification ¶ Placeholder: SysTarget Default Resolution: SysTarget, * (System) Namespace: SysTarget Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTarget SysTime ¶ Library Identification ¶ Placeholder: SysTime Default Resolution: SysTime, * (System) Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime SysTypes Interfaces ¶ Library Identification ¶ Name: SysTypes Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes Interfaces, * (System)
CreateRWUser (FUN) ¶ FUNCTION CreateRWUser : BOOL Create and register an user with read and write access for the SNMP_AGENT . This function should only be used in combination with the function block SNMP_AGENT to enable write access for SET requests. InOut: Scope Name Type Comment Return CreateRWUser BOOL Input sName STRING Name of the user eAuthMethod AuthMethods The authentification method sAuthPwd STRING(64) The authentification password ePrivMethod PrivMethods The encryption method sPrivPwd STRING(64) The encryption password Output eError Error
CreateUser (FUN) ¶ FUNCTION CreateUser : BOOL Function to create and register an user (‘Read Only’ access for SNMP_AGENT). InOut: Scope Name Type Comment Return CreateUser BOOL Input sName STRING Name of the user eAuthMethod AuthMethods The authentification method sAuthPwd STRING(64) The authentification password ePrivMethod PrivMethods The encryption method sPrivPwd STRING(64) The encryption password Output eError Error
SNMP_GET_REQUEST.Reset (METH) ¶ METHOD Reset Reset udp_peer and internal arrays.
SNMP_SET.Reset (METH) ¶ METHOD Reset Reset udp_peer and internal arrays.
SNMP_TRAP_SENDER.Reset (METH) ¶ METHOD Reset Reset udp_peer and internal arrays.
Users ¶ CreateRWUser (Function) CreateUser (Function) DeleteUser (Function)
SNMP_SET (FB) ¶ FUNCTION_BLOCK SNMP_SET Function block to send SNMP SET request to an agent. InOut: Scope Name Type Initial Comment Input xExecute BOOL Starts the request sHost STRING(100) Hostname or IP address of the SNMP agent sOwnIP STRING(100) Hostname or IP address of the SNMP master (the IP of the control) snmpVarBindings REFERENCE TO ARRAY [0..(gc_uiMaxSNMPValues - 1)] OF SNMPVarBinding Variable bindings (OID/Value) to send iNumberOfVarBindings INT Number of variable bindings. uiPeerPort UINT 161 Port of the sender (the control) uiSendPort UINT 161 Port of the agent (printer, router etc.) sCommunity STRING ‘public’ The community, default: ‘public’ xClosePeer BOOL Rising edge closes the UDP peer. uiTimeout UINT 1000 Timeout in milliseconds, default: 1000 ms bySNMPVersion SNMPVersion SNMPVersion.V1 SNMP Version, default: V1 sUserName STRING ‘’ SNMP V3 only: Name of the registered user. Use the function CreateUser to register an user. sContextName STRING ‘’ SNMP V3 only: Context name xRequestReport BOOL TRUE SNMP V3 only: TRUE: Requests a report to discover the engineId of the agent, Default: TRUE Output xBusy BOOL True while busy xDone BOOL True if the call has finished xError BOOL True if an error occured aSNMPValues ARRAY [0..gc_uiMaxSNMPValues] OF SNMPValue The result of the set request iSize INT Size of aSNMPValues eError ERROR Error state of the function block diErrorStatus DINT SNMP error status of the last request diErrorIndex DINT SNMP error index of the last request (index of the object that caused the error) diRequestId DINT SNMP request id of the last request abResponse ARRAY [0..(gc_uiMaxTelegramLength - 1)] OF BYTE msgAuthoritativeEngineID SNMPValue SNMP V3 only: The authoritative engine Id. If xRequestReport = TRUE then this is the discovered engine id of the agent. If xRequestReport = FALSE then GVL.g_pEngineId is used. Methods: Reset Structure: Reset (Method)